Public Types
using	iterator_category = typename iterator_traits< _Iterator >::iterator_category

using	value_type = typename iterator_traits< _Iterator >::value_type

using	difference_type = typename iterator_traits< _Iterator >::difference_type

using	pointer = typename iterator_traits< _Iterator >::pointer

using	reference = typename iterator_traits< _Iterator >::reference

typedef _Iterator	_Unchecked_type

Public Member Functions
	checked_array_iterator ()

	checked_array_iterator (const _Iterator _Array, const size_t _Size, const size_t _Index=0)

_Iterator	base () const

checked_array_iterator &	_Rechecked (const _Unchecked_type _Right)

_Unchecked_type	_Unchecked () const

reference	operator* () const

pointer	operator-> () const

checked_array_iterator &	operator++ ()

checked_array_iterator	operator++ (int)

checked_array_iterator &	operator-- ()

checked_array_iterator	operator-- (int)

checked_array_iterator &	operator+= (const difference_type _Off)

checked_array_iterator	operator+ (const difference_type _Off) const

checked_array_iterator &	operator-= (const difference_type _Off)

checked_array_iterator	operator- (const difference_type _Off) const

difference_type	operator- (const checked_array_iterator &_Right) const

reference	operator[] (const difference_type _Off) const

bool	operator== (const checked_array_iterator &_Right) const

bool	operator!= (const checked_array_iterator &_Right) const

bool	operator< (const checked_array_iterator &_Right) const

bool	operator> (const checked_array_iterator &_Right) const

bool	operator<= (const checked_array_iterator &_Right) const

bool	operator>= (const checked_array_iterator &_Right) const

Private Attributes
_Iterator	_Myarray

size_t	_Mysize

size_t	_Myindex

Member Typedef Documentation

template<class _Iterator>

typedef _Iterator checked_array_iterator< _Iterator >::_Unchecked_type

template<class _Iterator>

using checked_array_iterator< _Iterator >::difference_type = typename iterator_traits<_Iterator>::difference_type

template<class _Iterator>

using checked_array_iterator< _Iterator >::iterator_category = typename iterator_traits<_Iterator>::iterator_category

template<class _Iterator>

using checked_array_iterator< _Iterator >::pointer = typename iterator_traits<_Iterator>::pointer

template<class _Iterator>

using checked_array_iterator< _Iterator >::reference = typename iterator_traits<_Iterator>::reference

template<class _Iterator>

using checked_array_iterator< _Iterator >::value_type = typename iterator_traits<_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	(	const _Iterator	_Array,
		const size_t	_Size,
		const size_t	_Index = `0`
	)

inline

         : _Myarray(_Array), _Mysize(_Size), _Myindex(_Index)
         {   // construct with array, size, and optional index
         _IDL_VERIFY_ALWAYS(_Index <= _Size, "checked_array_iterator construction index out of range");
         }

Member Function Documentation

template<class _Iterator>

checked_array_iterator& checked_array_iterator< _Iterator >::_Rechecked ( const _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 checked_array_iterator< _Iterator > & _Right ) const

inline

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

template<class _Iterator>

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

inline

         {   // return designated object
         _IDL_VERIFY_ALWAYS(_Myarray, "cannot dereference value-initialized or null checked_array_iterator");
         _IDL_VERIFY_ALWAYS(_Myindex < _Mysize, "cannot dereference end checked_array_iterator");
         return (_Myarray[_Myindex]);
         }

template<class _Iterator>

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

inline

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

template<class _Iterator>

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

inline

         {   // preincrement
         _IDL_VERIFY_ALWAYS(_Myarray, "cannot increment value-initialized or null checked_array_iterator");
         _IDL_VERIFY_ALWAYS(_Myindex < _Mysize, "cannot increment checked_array_iterator past end");
         ++_Myindex;
         return (*this);
         }

template<class _Iterator>

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

inline

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

template<class _Iterator>

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

inline

         {   // increment by integer
         if (_Off != 0)
             {
             _IDL_VERIFY_ALWAYS(_Myarray, "cannot seek value-initialized or null checked_array_iterator");
             }
 
         if (_Off < 0)
             {
 #pragma warning(suppress: 4146) // unary minus operator applied to unsigned type, result still unsigned
             _IDL_VERIFY_ALWAYS(_Myindex >= -static_cast<size_t>(_Off),
                 "cannot seek checked_array_iterator before begin");
             }
 
         if (_Off > 0)
             {
             _IDL_VERIFY_ALWAYS(_Mysize - _Myindex >= static_cast<size_t>(_Off),
                 "cannot seek checked_array_iterator after end")
             }
 
         _Myindex += _Off;
         return (*this);
         }

template<class _Iterator>

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

inline

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

template<class _Iterator>

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

inline

         {   // return difference of iterators
         _IDL_VERIFY_ALWAYS(_Myarray == _Right._Myarray && _Mysize == _Right._Mysize,
             "cannot subtract incompatible checked_array_iterators");
         return (_Myindex - _Right._Myindex);
         }

template<class _Iterator>

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

inline

         {   // predecrement
         _IDL_VERIFY_ALWAYS(_Myarray, "cannot decrement value-initialized or null checked_array_iterator");
         _IDL_VERIFY_ALWAYS(_Myindex != 0, "cannot decrement checked_array_iterator before begin");
         --_Myindex;
         return (*this);
         }

template<class _Iterator>

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

inline

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

template<class _Iterator>

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

inline

         {   // decrement by integer
         if (_Off != 0)
             {
             _IDL_VERIFY_ALWAYS(_Myarray, "cannot seek value-initialized or null checked_array_iterator");
             }
 
         if (_Off > 0)
             {
             _IDL_VERIFY_ALWAYS(_Myindex >= static_cast<size_t>(_Off),
                 "cannot seek checked_array_iterator before begin");
             }
 
         if (_Off < 0)
             {
 #pragma warning(suppress: 4146) // unary minus operator applied to unsigned type, result still unsigned
             _IDL_VERIFY_ALWAYS(_Mysize - _Myindex >= -static_cast<size_t>(_Off),
                 "cannot seek checked_array_iterator after end");
             }
 
         _Myindex -= _Off;
         return (*this);
         }

template<class _Iterator>

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

inline

         {   // return pointer to class object
         _IDL_VERIFY_ALWAYS(_Myarray, "cannot dereference value-initialized or null checked_array_iterator");
         _IDL_VERIFY_ALWAYS(_Myindex < _Mysize, "cannot dereference end checked_array_iterator");
         return (_Myarray + _Myindex);
         }

template<class _Iterator>

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

inline

         {   // test if this < _Right
         _IDL_VERIFY_ALWAYS(_Myarray == _Right._Myarray && _Mysize == _Right._Mysize,
             "cannot compare incompatible checked_array_iterators");
         return (_Myindex < _Right._Myindex);
         }

template<class _Iterator>

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

inline

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

template<class _Iterator>

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

inline

         {   // test for iterator equality
         _IDL_VERIFY_ALWAYS(_Myarray == _Right._Myarray && _Mysize == _Right._Mysize,
             "cannot compare incompatible checked_array_iterators for equality");
         return (_Myindex == _Right._Myindex);
         }

template<class _Iterator>

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

inline

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

template<class _Iterator>

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

inline

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

template<class _Iterator>

reference checked_array_iterator< _Iterator >::operator[] ( const 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:

VS2017/inc/iterator

Public Types

Public Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation