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

#include <BALL/CONCEPT/forwardIterator.h>

Inheritance diagram for BALL::ForwardIterator< Container, DataType, Position, Traits >:
Inheritance graph
[legend]

List of all members.

Public Types

Typedefs

typedef DataType & reference
typedef DataType * pointer
typedef ConstForwardIterator
< Container, DataType,
Position, Traits > 
Base
typedef DataType & reference
typedef DataType * pointer
typedef ConstForwardIterator
< Container, DataType,
Position, Traits > 
Base

Public Member Functions

Constructors and Destructors

BALL_INLINE ForwardIterator ()
BALL_INLINE ForwardIterator (const ForwardIterator &iterator)
BALL_INLINE ~ForwardIterator ()
 ForwardIterator ()
 ForwardIterator (const ForwardIterator &iterator)
 ~ForwardIterator ()
Assignemnt

BALL_INLINE ForwardIteratoroperator= (const ForwardIterator &iterator)
BALL_INLINE void swap (ForwardIterator &iterator)
ForwardIteratoroperator= (const ForwardIterator &iterator)
void swap (ForwardIterator &iterator)

Protected Member Functions

BALL_INLINE ForwardIterator (const Container &container)
 ForwardIterator (const Container &container)

Iterator methods



BALL_INLINE reference operator* () const
 Convert an iterator to its Datatype by returning a reference to the current data.
BALL_INLINE pointer operator-> () const
 Return a pointer to the current data.
BALL_INLINE ForwardIteratoroperator++ ()
BALL_INLINE ForwardIterator operator++ (int)
reference operator* () const
 Convert an iterator to its Datatype by returning a reference to the current data.
pointer operator-> () const
 Return a pointer to the current data.
ForwardIteratoroperator++ ()
ForwardIterator operator++ (int)
static ForwardIterator begin (const Container &container)
static ForwardIterator end (const Container &container)
static ForwardIterator begin (const Container &container)
static ForwardIterator end (const Container &container)

Detailed Description

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

Generic mutable forward iterator class

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


Member Typedef Documentation

template<typename Container , typename DataType , typename Position , typename Traits >
typedef ConstForwardIterator<Container, DataType, Position, Traits> BALL::ForwardIterator< Container, DataType, Position, Traits >::Base
template<typename Container , typename DataType , typename Position , typename Traits >
typedef ConstForwardIterator<Container, DataType, Position, Traits> BALL::ForwardIterator< Container, DataType, Position, Traits >::Base
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType* BALL::ForwardIterator< Container, DataType, Position, Traits >::pointer
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType* BALL::ForwardIterator< Container, DataType, Position, Traits >::pointer
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType& BALL::ForwardIterator< Container, DataType, Position, Traits >::reference
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType& BALL::ForwardIterator< Container, DataType, Position, Traits >::reference

Constructor & Destructor Documentation

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE BALL::ForwardIterator< Container, DataType, Position, Traits >::ForwardIterator (  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE BALL::ForwardIterator< Container, DataType, Position, Traits >::ForwardIterator ( const ForwardIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE BALL::ForwardIterator< Container, DataType, Position, Traits >::~ForwardIterator (  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE BALL::ForwardIterator< Container, DataType, Position, Traits >::ForwardIterator ( const Container &  container  )  [inline, protected]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL::ForwardIterator< Container, DataType, Position, Traits >::ForwardIterator (  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL::ForwardIterator< Container, DataType, Position, Traits >::ForwardIterator ( const ForwardIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL::ForwardIterator< Container, DataType, Position, Traits >::~ForwardIterator (  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL::ForwardIterator< Container, DataType, Position, Traits >::ForwardIterator ( const Container &  container  )  [inline, protected]

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


Member Function Documentation

template<typename Container , typename DataType , typename Position , typename Traits >
static ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::begin ( const Container &  container  )  [static]

Return an iterator pointing to the beginning of the container

Exceptions:
Exception::Precondition 

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

template<typename Container , typename DataType , typename Position , typename Traits >
ForwardIterator< Container, DataType, Position, Traits > BALL::ForwardIterator< Container, DataType, Position, Traits >::begin ( const Container &  container  )  [inline, static]

Return an iterator pointing to the beginning of the container

Exceptions:
Exception::Precondition 

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
static ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::end ( const Container &  container  )  [static]

Return an iterator pointing at the end of the container

Exceptions:
Exception::Precondition 

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

template<typename Container , typename DataType , typename Position , typename Traits >
ForwardIterator< Container, DataType, Position, Traits > BALL::ForwardIterator< Container, DataType, Position, Traits >::end ( const Container &  container  )  [inline, static]

Return an iterator pointing at the end of the container

Exceptions:
Exception::Precondition 

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
reference BALL::ForwardIterator< Container, DataType, Position, Traits >::operator* (  )  const [inline]

Convert an iterator to its Datatype by returning a reference to the current data.

Reimplemented from BALL::BaseIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE reference BALL::ForwardIterator< Container, DataType, Position, Traits >::operator* (  )  const [inline]

Convert an iterator to its Datatype by returning a reference to the current data.

Reimplemented from BALL::BaseIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ ( int   )  [inline]

Postfix increment operator

Exceptions:
Exception::InvalidIterator if the iterator is invalid

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
ForwardIterator& BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ (  )  [inline]

Increment operator

Exceptions:
Exception::InvalidIterator if the iterator is invalid

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ ( int   )  [inline]

Postfix increment operator

Exceptions:
Exception::Precondition 

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ForwardIterator& BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ (  )  [inline]

Increment operator

Exceptions:
Exception::Precondition 

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
pointer BALL::ForwardIterator< Container, DataType, Position, Traits >::operator-> (  )  const [inline]

Return a pointer to the current data.

Reimplemented from BALL::BaseIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE pointer BALL::ForwardIterator< Container, DataType, Position, Traits >::operator-> (  )  const [inline]

Return a pointer to the current data.

Reimplemented from BALL::BaseIterator< Container, DataType, Position, Traits >.

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

template<typename Container , typename DataType , typename Position , typename Traits >
ForwardIterator& BALL::ForwardIterator< Container, DataType, Position, Traits >::operator= ( const ForwardIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ForwardIterator& BALL::ForwardIterator< Container, DataType, Position, Traits >::operator= ( const ForwardIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
void BALL::ForwardIterator< Container, DataType, Position, Traits >::swap ( ForwardIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE void BALL::ForwardIterator< Container, DataType, Position, Traits >::swap ( ForwardIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

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

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated by  doxygen 1.6.3