checked_array_iterator< _Iterator > Class Template Reference

Public Types
typedef checked_array_iterator< _Iterator >	_Myt
typedef iterator_traits< _Iterator >::iterator_category	iterator_category
typedef iterator_traits< _Iterator >::value_type	value_type
typedef iterator_traits< _Iterator >::difference_type	difference_type
typedef iterator_traits< _Iterator >::difference_type	distance_type
typedef iterator_traits< _Iterator >::pointer	pointer
typedef iterator_traits< _Iterator >::reference	reference
typedef _Iterator	_Unchecked_type

Public Member Functions
	checked_array_iterator ()
	checked_array_iterator (_Iterator _Array, size_t _Size, size_t _Index=0)
_Iterator	base () const
_Myt &	_Rechecked (_Unchecked_type _Right)
_Unchecked_type	_Unchecked () const
reference	operator* () const
pointer	operator-> () const
_Myt &	operator++ ()
_Myt	operator++ (int)
_Myt &	operator-- ()
_Myt	operator-- (int)
_Myt &	operator+= (difference_type _Off)
_Myt	operator+ (difference_type _Off) const
_Myt &	operator-= (difference_type _Off)
_Myt	operator- (difference_type _Off) const
difference_type	operator- (const _Myt &_Right) const
reference	operator[] (difference_type _Off) const
bool	operator== (const _Myt &_Right) const
bool	operator!= (const _Myt &_Right) const
bool	operator< (const _Myt &_Right) const
bool	operator> (const _Myt &_Right) const
bool	operator<= (const _Myt &_Right) const
bool	operator>= (const _Myt &_Right) const

Private Attributes
_Iterator	_Myarray
size_t	_Mysize
size_t	_Myindex

Member Typedef Documentation

template<class _Iterator>

typedef checked_array_iterator<_Iterator> checked_array_iterator< _Iterator >::_Myt

template<class _Iterator>

typedef _Iterator checked_array_iterator< _Iterator >::_Unchecked_type

template<class _Iterator>

typedef iterator_traits<_Iterator>::difference_type checked_array_iterator< _Iterator >::difference_type

template<class _Iterator>

typedef iterator_traits<_Iterator>::difference_type checked_array_iterator< _Iterator >::distance_type

template<class _Iterator>

typedef iterator_traits<_Iterator>::iterator_category checked_array_iterator< _Iterator >::iterator_category

template<class _Iterator>

typedef iterator_traits<_Iterator>::pointer checked_array_iterator< _Iterator >::pointer

template<class _Iterator>

typedef iterator_traits<_Iterator>::reference checked_array_iterator< _Iterator >::reference

template<class _Iterator>

typedef iterator_traits<_Iterator>::value_type checked_array_iterator< _Iterator >::value_type

Constructor & Destructor Documentation

template<class _Iterator>

checked_array_iterator< _Iterator >::checked_array_iterator ( )

inline

        : _Myarray(), _Mysize(0), _Myindex(0)
        {   // default construct
        }

template<class _Iterator>

checked_array_iterator< _Iterator >::checked_array_iterator ( _Iterator  _Array, size_t  _Size, size_t  _Index = 0  )

inline

        : _Myarray(_Array), _Mysize(_Size), _Myindex(_Index)
        {   // construct with array, size, and optional index
        _SCL_SECURE_ALWAYS_VALIDATE(_Index <= _Size);
        }

Member Function Documentation

template<class _Iterator>

_Myt& checked_array_iterator< _Iterator >::_Rechecked ( _Unchecked_type  _Right )

inline

        {   // reset from unchecked iterator
        _Myindex = _Right - _Myarray;
        return (*this);
        }

template<class _Iterator>

_Unchecked_type checked_array_iterator< _Iterator >::_Unchecked ( ) const

inline

        {   // make an unchecked iterator
        return (base());
        }

template<class _Iterator>

_Iterator checked_array_iterator< _Iterator >::base ( ) const

inline

        {   // return unwrapped iterator
        return (_Myarray + _Myindex);
        }

template<class _Iterator>

bool checked_array_iterator< _Iterator >::operator!= ( const _Myt &  _Right ) const

inline

        {   // test for iterator inequality
        return (!(*this == _Right));
        }

template<class _Iterator>

reference checked_array_iterator< _Iterator >::operator* ( ) const

inline

        {   // return designated object
        _SCL_SECURE_ALWAYS_VALIDATE_RANGE(_Myarray != 0
            && _Myindex < _Mysize);
        return (_Myarray[_Myindex]);
        }

template<class _Iterator>

_Myt checked_array_iterator< _Iterator >::operator+ ( difference_type  _Off ) const

inline

        {   // return this + integer
        _Myt _Tmp = *this;
        return (_Tmp += _Off);
        }

template<class _Iterator>

_Myt& checked_array_iterator< _Iterator >::operator++ ( )

inline

        {   // preincrement
        _SCL_SECURE_ALWAYS_VALIDATE_RANGE(_Myarray != 0
            && _Myindex < _Mysize);
        ++_Myindex;
        return (*this);
        }

template<class _Iterator>

_Myt checked_array_iterator< _Iterator >::operator++ ( int  )

inline

        {   // postincrement
        _Myt _Tmp = *this;
        ++*this;
        return (_Tmp);
        }

template<class _Iterator>

_Myt& checked_array_iterator< _Iterator >::operator+= ( difference_type  _Off )

inline

        {   // increment by integer
        _SCL_SECURE_ALWAYS_VALIDATE_RANGE(_Myarray != 0
            && _Myindex + _Off <= _Mysize);
        _Myindex += _Off;
        return (*this);
        }

template<class _Iterator>

_Myt checked_array_iterator< _Iterator >::operator- ( difference_type  _Off ) const

inline

        {   // return this - integer
        _Myt _Tmp = *this;
        return (_Tmp -= _Off);
        }

template<class _Iterator>

difference_type checked_array_iterator< _Iterator >::operator- ( const _Myt &  _Right ) const

inline

        {   // return difference of iterators
        _SCL_SECURE_ALWAYS_VALIDATE(_Myarray == _Right._Myarray);
        return (_Myindex - _Right._Myindex);
        }

template<class _Iterator>

_Myt& checked_array_iterator< _Iterator >::operator-- ( )

inline

        {   // predecrement
        _SCL_SECURE_ALWAYS_VALIDATE_RANGE(_Myarray != 0
            && 0 < _Myindex);
        --_Myindex;
        return (*this);
        }

template<class _Iterator>

_Myt checked_array_iterator< _Iterator >::operator-- ( int  )

inline

        {   // postdecrement
        _Myt _Tmp = *this;
        --*this;
        return (_Tmp);
        }

template<class _Iterator>

_Myt& checked_array_iterator< _Iterator >::operator-= ( difference_type  _Off )

inline

        {   // decrement by integer
        return (*this += -_Off);
        }

template<class _Iterator>

pointer checked_array_iterator< _Iterator >::operator-> ( ) const

inline

        {   // return pointer to class object
        return (_STD pointer_traits<pointer>::pointer_to(**this));
        }

template<class _Iterator>

bool checked_array_iterator< _Iterator >::operator< ( const _Myt &  _Right ) const

inline

        {   // test if this < _Right
        _SCL_SECURE_ALWAYS_VALIDATE(_Myarray == _Right._Myarray);
        return (_Myindex < _Right._Myindex);
        }

template<class _Iterator>

bool checked_array_iterator< _Iterator >::operator<= ( const _Myt &  _Right ) const

inline

        {   // test if this <= _Right
        return (!(_Right < *this));
        }

template<class _Iterator>

bool checked_array_iterator< _Iterator >::operator== ( const _Myt &  _Right ) const

inline

        {   // test for iterator equality
        _SCL_SECURE_ALWAYS_VALIDATE(_Myarray == _Right._Myarray);
        return (_Myindex == _Right._Myindex);
        }

template<class _Iterator>

bool checked_array_iterator< _Iterator >::operator> ( const _Myt &  _Right ) const

inline

        {   // test if this > _Right
        return (_Right < *this);
        }

template<class _Iterator>

bool checked_array_iterator< _Iterator >::operator>= ( const _Myt &  _Right ) const

inline

        {   // test if this >= _Right
        return (!(*this < _Right));
        }

template<class _Iterator>

reference checked_array_iterator< _Iterator >::operator[] ( difference_type  _Off ) const

inline

        {   // subscript
        return (*(*this + _Off));
        }

Member Data Documentation

template<class _Iterator>

_Iterator checked_array_iterator< _Iterator >::_Myarray

private

template<class _Iterator>

size_t checked_array_iterator< _Iterator >::_Myindex

private

template<class _Iterator>

size_t checked_array_iterator< _Iterator >::_Mysize

private

---

The documentation for this class was generated from the following file:

• VS2013/inc/iterator