N1DArray< stored_type >::Iterator Class Reference

#include <N1DArray.h>

List of all members.

Public Member Functions
	Iterator (N1DArray< stored_type > *a)
	Iterator (N1DArray< stored_type > *a, unsigned int b)
Iterator &	operator= (const Iterator &other)
bool	operator== (const Iterator &other)
bool	operator!= (const Iterator &other)
Iterator &	operator++ ()
stored_type	operator * ()
Private Attributes
unsigned int	at
N1DArray< stored_type > *	arr

---

Detailed Description

template<typename stored_type>
class N1DArray< stored_type >::Iterator

Defines a STL iterator on the N1DArray

Definition at line 106 of file N1DArray.h.

---

Constructor & Destructor Documentation

template<typename stored_type>

N1DArray< stored_type >::Iterator::Iterator

(

N1DArray< stored_type > *

a

)

[inline]

Base constructor.

Parameters:

a

The N1DArray we would like to iterate on

Definition at line 123 of file N1DArray.h.

References N1DArray< stored_type >::Iterator::arr, and N1DArray< stored_type >::Iterator::at.

template<typename stored_type>

N1DArray< stored_type >::Iterator::Iterator	(	N1DArray< stored_type > *	a,
		unsigned int	b
	)			[inline]

Base constructor.

Parameters:

	a	The N1DArray we would like to iterate on
	b	The position in the 1D representation we would like to start iterating at

Definition at line 135 of file N1DArray.h.

References N1DArray< stored_type >::Iterator::arr, and N1DArray< stored_type >::Iterator::at.

---

Member Function Documentation

template<typename stored_type>

Iterator& N1DArray< stored_type >::Iterator::operator=

(

const Iterator &

other

)

[inline]

Assignment operator

Definition at line 141 of file N1DArray.h.

References N1DArray< stored_type >::Iterator::arr, and N1DArray< stored_type >::Iterator::at.

template<typename stored_type>

bool N1DArray< stored_type >::Iterator::operator==

(

const Iterator &

other

)

[inline]

Equality operator

Definition at line 148 of file N1DArray.h.

References N1DArray< stored_type >::Iterator::arr, and N1DArray< stored_type >::Iterator::at.

template<typename stored_type>

bool N1DArray< stored_type >::Iterator::operator!=

(

const Iterator &

other

)

[inline]

Inequality operator

Definition at line 153 of file N1DArray.h.

References N1DArray< stored_type >::Iterator::arr, and N1DArray< stored_type >::Iterator::at.

template<typename stored_type>

Iterator& N1DArray< stored_type >::Iterator::operator++

(

)

[inline]

Increment operator; basically just increments the at-variable.

Definition at line 158 of file N1DArray.h.

References N1DArray< stored_type >::Iterator::at.

template<typename stored_type>

stored_type N1DArray< stored_type >::Iterator::operator *

(

)

[inline]

Dereference operator.

Returns:

The stored object the current iterator is pointing to

Definition at line 169 of file N1DArray.h.

References N1DArray< stored_type >::Iterator::arr, and N1DArray< stored_type >::Iterator::at.

---

Member Data Documentation

template<typename stored_type>

unsigned int N1DArray< stored_type >::Iterator::at [private]

Position of the iterator in terms of 1D array index

Definition at line 110 of file N1DArray.h.

Referenced by N1DArray< stored_type >::Iterator::Iterator(), N1DArray< stored_type >::Iterator::operator *(), N1DArray< stored_type >::Iterator::operator!=(), N1DArray< stored_type >::Iterator::operator++(), N1DArray< stored_type >::Iterator::operator=(), and N1DArray< stored_type >::Iterator::operator==().

template<typename stored_type>

N1DArray< stored_type >* N1DArray< stored_type >::Iterator::arr [private]

Pointer to the N1DArray we are iterating on

Definition at line 113 of file N1DArray.h.

Referenced by N1DArray< stored_type >::Iterator::Iterator(), N1DArray< stored_type >::Iterator::operator *(), N1DArray< stored_type >::Iterator::operator!=(), N1DArray< stored_type >::Iterator::operator=(), and N1DArray< stored_type >::Iterator::operator==().

---

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

• N1DArray.h

---