BALL::ConstForwardIterator< Container, DataType, Position, Traits > Class Template Reference

#include <BALL/CONCEPT/forwardIterator.h>

Inheritance diagram for BALL::ConstForwardIterator< Container, DataType, Position, Traits >:

Public Types
Typedefs
typedef std::forward_iterator_tag	iterator_category
typedef BaseIterator < Container, DataType, Position, Traits >	Base
typedef std::forward_iterator_tag	iterator_category
typedef BaseIterator < Container, DataType, Position, Traits >	Base
Public Types inherited from BALL::BaseIterator< Container, DataType, Position, Traits >
typedef DataType	value_type
typedef Position	difference_type
typedef const DataType *	pointer
typedef const DataType &	reference
typedef std::input_iterator_tag	iterator_category
typedef DataType	value_type
typedef Position	difference_type
typedef const DataType *	pointer
typedef const DataType &	reference
typedef Container	container_type
typedef Traits	traits_type
typedef std::input_iterator_tag	iterator_category

Public Member Functions
Constructors and Destructors
BALL_INLINE	ConstForwardIterator ()
	Default constructor. More...
BALL_INLINE	ConstForwardIterator (const ConstForwardIterator &iterator)
	Copy constructor. More...
BALL_INLINE	~ConstForwardIterator ()
	ConstForwardIterator ()
	Default constructor. More...
	ConstForwardIterator (const ConstForwardIterator &iterator)
	Copy constructor. More...
	~ConstForwardIterator ()
Assignment
BALL_INLINE ConstForwardIterator &	operator= (const ConstForwardIterator &iterator)
BALL_INLINE void	swap (ConstForwardIterator &iterator)
ConstForwardIterator &	operator= (const ConstForwardIterator &iterator)
void	swap (ConstForwardIterator &iterator)
Public Member Functions inherited from BALL::BaseIterator< Container, DataType, Position, Traits >
BALL_INLINE	BaseIterator ()
	Default constructor. More...
BALL_INLINE	BaseIterator (const BaseIterator &iterator)
	Copy constructor. More...
BALL_INLINE	~BaseIterator ()
	Destructor. More...
	BaseIterator ()
	Default constructor. More...
	BaseIterator (const BaseIterator &iterator)
	Copy constructor. More...
	~BaseIterator ()
	Destructor. More...
BALL_INLINE BaseIterator &	operator= (const BaseIterator &iterator)
BALL_INLINE void	swap (BaseIterator &iterator)
	Swap two iterators. More...
BaseIterator &	operator= (const BaseIterator &iterator)
void	swap (BaseIterator &iterator)
	Swap two iterators. More...
BALL_INLINE void	invalidate ()
	Invalidate the iterator. More...
BALL_INLINE void	setTraits (const Traits &traits)
	Set the traits. More...
BALL_INLINE const Traits &	getTraits () const
	Get a constant reference to the traits of this iterator. More...
BALL_INLINE Traits &	getTraits ()
	Get a constant reference to the traits of this iterator. More...
BALL_INLINE const Container *	getContainer () const
	Get a constant pointer to the container of this iterator. More...
void	invalidate ()
	Invalidate the iterator. More...
void	setTraits (const Traits &traits)
	Set the traits. More...
const Traits &	getTraits () const
	Get a constant reference to the traits of this iterator. More...
Traits &	getTraits ()
	Get a constant reference to the traits of this iterator. More...
const Container *	getContainer () const
	Get a constant pointer to the container of this iterator. More...
BALL_INLINE	operator const Position & () const
BALL_INLINE reference	operator* () const
	Convert an iterator to its Datatype by returning a reference to the current data. More...
BALL_INLINE pointer	operator-> () const
	Return a pointer to the current data. More...
	operator const Position & () const
reference	operator* () const
	Convert an iterator to its Datatype by returning a reference to the current data. More...
pointer	operator-> () const
	Return a pointer to the current data. More...
BALL_INLINE bool	operator== (const BaseIterator &iterator) const
	Equality operator. More...
BALL_INLINE bool	operator!= (const BaseIterator &iterator) const
	Inequality operator. More...
BALL_INLINE bool	isSingular () const
BALL_INLINE bool	isValid () const
BALL_INLINE bool	operator+ () const
	Validity predicate. More...
BALL_INLINE bool	operator- () const
	Invalidity perdicate. More...
bool	operator== (const BaseIterator &iterator) const
	Equality operator. More...
bool	operator!= (const BaseIterator &iterator) const
	Inequality operator. More...
bool	isSingular () const
bool	isValid () const
bool	operator+ () const
	Validity predicate. More...
bool	operator- () const
	Invalidity predicate. More...

Protected Member Functions
BALL_INLINE	ConstForwardIterator (const Container &container)
	ConstForwardIterator (const Container &container)
Protected Member Functions inherited from BALL::BaseIterator< Container, DataType, Position, Traits >
BALL_INLINE	BaseIterator (const Container &container)
	BaseIterator (const Container &container)

Iterator methods
BALL_INLINE void	toBegin ()
BALL_INLINE bool	isBegin () const
	Check whether the iterator points to the first item of the container. More...
BALL_INLINE void	toEnd ()
BALL_INLINE bool	isEnd () const
	Check whether the iterator points behind the last item of the container. More...
BALL_INLINE ConstForwardIterator &	operator++ ()
BALL_INLINE ConstForwardIterator	operator++ (int)
void	toBegin ()
bool	isBegin () const
	Check whether the iterator points to the first item of the container. More...
void	toEnd ()
bool	isEnd () const
	Check whether the iterator points behind the last item of the container. More...
ConstForwardIterator &	operator++ ()
ConstForwardIterator	operator++ (int)
static ConstForwardIterator	begin (const Container &container)
static ConstForwardIterator	end (const Container &container)
static ConstForwardIterator	begin (const Container &container)
static ConstForwardIterator	end (const Container &container)

Detailed Description

template<typename Container, typename DataType, typename Position, typename Traits>
class BALL::ConstForwardIterator< Container, DataType, Position, Traits >

Generic non-mutable forward itterator

Generic non-mutable forward iterator

Definition at line 24 of file CONCEPT/forwardIterator.h.

Member Typedef Documentation

template<typename Container, typename DataType, typename Position, typename Traits>

typedef BaseIterator<Container, DataType, Position, Traits> BALL::ConstForwardIterator< Container, DataType, Position, Traits >::Base

Definition at line 33 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

typedef BaseIterator<Container, DataType, Position, Traits> BALL::ConstForwardIterator< Container, DataType, Position, Traits >::Base

Definition at line 36 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

typedef std::forward_iterator_tag BALL::ConstForwardIterator< Container, DataType, Position, Traits >::iterator_category

Definition at line 31 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

typedef std::forward_iterator_tag BALL::ConstForwardIterator< Container, DataType, Position, Traits >::iterator_category

Definition at line 34 of file CONCEPT/forwardIterator.h.

Constructor & Destructor Documentation

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE BALL::ConstForwardIterator< Container, DataType, Position, Traits >::ConstForwardIterator ( )

inline

Default constructor.

Definition at line 44 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE BALL::ConstForwardIterator< Container, DataType, Position, Traits >::ConstForwardIterator ( const ConstForwardIterator< Container, DataType, Position, Traits > &  iterator )

inline

Copy constructor.

Definition at line 47 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE BALL::ConstForwardIterator< Container, DataType, Position, Traits >::~ConstForwardIterator ( )

inline

Definition at line 53 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE BALL::ConstForwardIterator< Container, DataType, Position, Traits >::ConstForwardIterator ( const Container &  container )

inlineprotected

Definition at line 127 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL::ConstForwardIterator< Container, DataType, Position, Traits >::ConstForwardIterator ( )

inline

Default constructor.

Definition at line 41 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL::ConstForwardIterator< Container, DataType, Position, Traits >::ConstForwardIterator ( const ConstForwardIterator< Container, DataType, Position, Traits > &  iterator )

inline

Copy constructor.

Definition at line 44 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL::ConstForwardIterator< Container, DataType, Position, Traits >::~ConstForwardIterator ( )

inline

Definition at line 50 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL::ConstForwardIterator< Container, DataType, Position, Traits >::ConstForwardIterator ( const Container &  container )

inlineprotected

Definition at line 132 of file MATHS/LINALG/forwardIterator.h.

Member Function Documentation

template<typename Container, typename DataType, typename Position, typename Traits>

static ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::begin ( const Container &  container )

static

Return an iterator pointing to the beginning of the container

Exceptions

Exception::Precondition

template<typename Container, typename DataType , typename Position , typename Traits >

ConstForwardIterator< Container, DataType, Position, Traits > BALL::ConstForwardIterator< Container, DataType, Position, Traits >::begin ( const Container &  container )

static

Return an iterator pointing to the beginning of the container

Exceptions

Exception::Precondition

Definition at line 145 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

static ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::end ( const Container &  container )

static

Return an iterator pointing at the end of the container

Exceptions

Exception::Precondition

template<typename Container, typename DataType , typename Position , typename Traits >

ConstForwardIterator< Container, DataType, Position, Traits > BALL::ConstForwardIterator< Container, DataType, Position, Traits >::end ( const Container &  container )

static

Return an iterator pointing at the end of the container

Exceptions

Exception::Precondition

Definition at line 175 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isBegin

(

)

const

Check whether the iterator points to the first item of the container.

template<typename Container , typename DataType , typename Position , typename Traits >

bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isBegin

(

)

const

Check whether the iterator points to the first item of the container.

Definition at line 154 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isEnd

(

)

const

Check whether the iterator points behind the last item of the container.

template<typename Container , typename DataType , typename Position , typename Traits >

bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isEnd

(

)

const

Check whether the iterator points behind the last item of the container.

Definition at line 184 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

ConstForwardIterator& BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ ( )

inline

Increment operator

Exceptions

Exception::InvalidOperator

if the iterator is invalid

Definition at line 101 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE ConstForwardIterator& BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ ( )

inline

Increment operator

Exceptions

Exception::Precondition

Definition at line 104 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ ( int  )

inline

Postfix increment operator

Exceptions

Exception::Precondition

Definition at line 114 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ ( int  )

inline

Postfix increment operator

Exceptions

Exception::InvalidOperator

if the iterator is invalid

Definition at line 115 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

ConstForwardIterator& BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator= ( const ConstForwardIterator< Container, DataType, Position, Traits > &  iterator )

inline

Definition at line 58 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE ConstForwardIterator& BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator= ( const ConstForwardIterator< Container, DataType, Position, Traits > &  iterator )

inline

Definition at line 61 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::swap ( ConstForwardIterator< Container, DataType, Position, Traits > &  iterator )

inline

Definition at line 65 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

BALL_INLINE void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::swap ( ConstForwardIterator< Container, DataType, Position, Traits > &  iterator )

inline

Definition at line 68 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toBegin

(

)

Move the iterator to the item at the beginning of the container

Exceptions

Exception::SingularIterator

if the iterator is Singular

template<typename Container , typename DataType , typename Position , typename Traits >

void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toBegin

(

)

Move the iterator to the item at the beginning of the container

Exceptions

Exception::Precondition

Definition at line 136 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>

void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toEnd

(

)

Move the iterator behind the last item of the container

Exceptions

Exception::SingularIterator

if the iterator is Singular

template<typename Container , typename DataType , typename Position , typename Traits >

void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toEnd

(

)

Move the iterator behind the last item of the container

Exceptions

Exception::Precondition

Definition at line 166 of file CONCEPT/forwardIterator.h.