ArrayIndexIterator< N > Class Template Reference

An index iterator for an array. More...

#include <ArrayIndexIterator.h>

List of all members.

Public Types
typedef Base::iterator_category	iterator_category
	Iterator category.
typedef Base::value_type	value_type
	Value type.
typedef Base::difference_type	difference_type
	Pointer difference type.
typedef Base::pointer	pointer
	Pointer to the value type.
typedef Base::reference	reference
	Reference to the value type.
Public Member Functions
Constructors etc.
	ArrayIndexIterator (const ArrayType &x)
	Construct an index iterator for an array.
	ArrayIndexIterator (const ArrayIndexIterator &x)
	Copy constructor.
ArrayIndexIterator &	operator= (const ArrayIndexIterator &x)
	Assignment operator.
	~ArrayIndexIterator ()
	Destructor.
Forward iterator requirements
reference	operator* () const
	Dereference.
pointer	operator-> () const
ArrayIndexIterator &	operator++ ()
	Pre-increment.
ArrayIndexIterator	operator++ (int)
	Post-increment.
Bidirectional iterator requirements
ArrayIndexIterator &	operator-- ()
	Pre-decrement.
ArrayIndexIterator	operator-- (int)
	Post-decrement.
Random access iterator requirements
reference	operator[] (const difference_type n) const
	Iterator indexing.
ArrayIndexIterator &	operator+= (const difference_type n)
	Positive offseting.
ArrayIndexIterator	operator+ (const difference_type n) const
	Positive offseting.
ArrayIndexIterator &	operator-= (const difference_type n)
	Negative offseting.
ArrayIndexIterator	operator- (const difference_type n) const
	Negative offseting.
int	base () const
	Return the container index.

---

Detailed Description

template<int N>
class ArrayIndexIterator< N >

An index iterator for an array.

---

Member Function Documentation

template<int N>

ArrayIndexIterator ArrayIndexIterator< N >::operator+

(

const difference_type

n

)

const [inline]

Positive offseting.

Note:

This is not efficient. If possible, use += instead.

template<int N>

ArrayIndexIterator ArrayIndexIterator< N >::operator++

(

int

)

[inline]

Post-increment.

Note:

This is not efficient. If possible, use the pre-increment operator instead.

template<int N>

ArrayIndexIterator ArrayIndexIterator< N >::operator-

(

const difference_type

n

)

const [inline]

Negative offseting.

Note:

This is not efficient. If possible, use -= instead.

template<int N>

ArrayIndexIterator ArrayIndexIterator< N >::operator--

(

int

)

[inline]

Post-decrement.

Note:

This is not efficient. If possible, use the pre-decrement operator instead.

template<int N>

pointer ArrayIndexIterator< N >::operator->

(

)

const [inline]

Todo:

What is this called.

References ArrayIndexingBase< N >::index_to_indices().

---

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

• ArrayIndexIterator.h