BALL  1.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Protected Member Functions | List of all members
BALL::BidirectionalIterator< Container, DataType, Position, Traits > Class Template Reference

Mutable bidirectional iterator. More...

#include <BALL/CONCEPT/bidirectionalIterator.h>

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

Public Types

Typedefs
typedef DataType & reference
 
typedef DataType * pointer
 
typedef
ConstBidirectionalIterator
< Container, DataType,
Position, Traits > 
Base
 
typedef DataType & reference
 
typedef DataType * pointer
 
typedef
ConstBidirectionalIterator
< Container, DataType,
Position, Traits > 
Base
 
- Public Types inherited from BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >
typedef
std::bidirectional_iterator_tag 
iterator_category
 
typedef ConstForwardIterator
< Container, DataType,
Position, Traits > 
Base
 
typedef
std::bidirectional_iterator_tag 
iterator_category
 
typedef ConstForwardIterator
< Container, DataType,
Position, Traits > 
Base
 
- Public Types inherited from BALL::ConstForwardIterator< Container, DataType, Position, Traits >
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 Destructor
BALL_INLINE BidirectionalIterator ()
 Default constructor. More...
 
BALL_INLINE BidirectionalIterator (const BidirectionalIterator &iterator)
 Copy constructor. More...
 
BALL_INLINE ~BidirectionalIterator ()
 Destructor. More...
 
 BidirectionalIterator ()
 Default constructor. More...
 
 BidirectionalIterator (const BidirectionalIterator &iterator)
 Copy constructor. More...
 
 ~BidirectionalIterator ()
 Destructor. More...
 
- Public Member Functions inherited from BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >
BALL_INLINE ConstBidirectionalIterator ()
 
BALL_INLINE ConstBidirectionalIterator (const ConstBidirectionalIterator &iterator)
 
BALL_INLINE ~ConstBidirectionalIterator ()
 
 ConstBidirectionalIterator ()
 
 ConstBidirectionalIterator (const ConstBidirectionalIterator &iterator)
 
 ~ConstBidirectionalIterator ()
 
BALL_INLINE void toBegin ()
 
BALL_INLINE bool isBegin () const
 Check whether the iterator points to the item at the beginning of the container. More...
 
void toEnd ()
 
BALL_INLINE bool isEnd () const
 Check whether the iterator points to the position after the last item of the container. More...
 
void toRBegin ()
 
BALL_INLINE bool isRBegin () const
 Test whether the iterator points to the "reverse" first element of the container. More...
 
void toREnd ()
 
BALL_INLINE bool isREnd () const
 Test wheter the iterator points to the position before the first element. More...
 
BALL_INLINE
ConstBidirectionalIterator
operator++ ()
 
BALL_INLINE
ConstBidirectionalIterator 
operator++ (int)
 
BALL_INLINE
ConstBidirectionalIterator
operator-- ()
 
BALL_INLINE
ConstBidirectionalIterator 
operator-- (int)
 
void toBegin ()
 
bool isBegin () const
 Check whether the iterator points to the item at the beginning of the container. More...
 
void toEnd ()
 
bool isEnd () const
 Check whether the iterator points to the position after the last item of the container. More...
 
void toRBegin ()
 
bool isRBegin () const
 Test whether the iterator points to the "reverse" first element of the container. More...
 
void toREnd ()
 
bool isREnd () const
 Test wheter the iterator points to the position before the first element. More...
 
ConstBidirectionalIteratoroperator++ ()
 
ConstBidirectionalIterator operator++ (int)
 
ConstBidirectionalIteratoroperator-- ()
 
ConstBidirectionalIterator operator-- (int)
 
- Public Member Functions inherited from BALL::ConstForwardIterator< Container, DataType, Position, Traits >
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 ()
 
BALL_INLINE ConstForwardIteratoroperator= (const ConstForwardIterator &iterator)
 
BALL_INLINE void swap (ConstForwardIterator &iterator)
 
ConstForwardIteratoroperator= (const ConstForwardIterator &iterator)
 
void swap (ConstForwardIterator &iterator)
 
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 ConstForwardIteratoroperator++ ()
 
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...
 
ConstForwardIteratoroperator++ ()
 
ConstForwardIterator operator++ (int)
 
- 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 BaseIteratoroperator= (const BaseIterator &iterator)
 
BALL_INLINE void swap (BaseIterator &iterator)
 Swap two iterators. More...
 
BaseIteratoroperator= (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 BidirectionalIterator (const Container &container)
 Construct an iterator bound to a specific container. More...
 
 BidirectionalIterator (const Container &container)
 Construct an iterator bound to a specific container. More...
 
- Protected Member Functions inherited from BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >
BALL_INLINE ConstBidirectionalIterator (const Container &container)
 Construct an iterator bound to a specific container. More...
 
 ConstBidirectionalIterator (const Container &container)
 Construct an iterator bound to a specific container. More...
 
- Protected Member Functions inherited from BALL::ConstForwardIterator< Container, DataType, Position, Traits >
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 reference operator* () const
 Dereferentiation. More...
 
BALL_INLINE pointer operator-> () const
 Pointer dereferentiation. More...
 
BALL_INLINE BidirectionalIteratoroperator++ ()
 
BALL_INLINE BidirectionalIterator operator++ (int)
 
BALL_INLINE BidirectionalIteratoroperator-- ()
 
BALL_INLINE BidirectionalIterator operator-- (int)
 
reference operator* () const
 Dereferentiation. More...
 
pointer operator-> () const
 Pointer dereferentiation. More...
 
BidirectionalIteratoroperator++ ()
 
BidirectionalIterator operator++ (int)
 
BidirectionalIteratoroperator-- ()
 
BidirectionalIterator operator-- (int)
 
static BidirectionalIterator begin (const Container &container)
 
static BidirectionalIterator end (const Container &container)
 
static BidirectionalIterator rbegin (const Container &container)
 
static BidirectionalIterator rend (const Container &container)
 
static BidirectionalIterator begin (const Container &container)
 
static BidirectionalIterator end (const Container &container)
 
static BidirectionalIterator rbegin (const Container &container)
 
static BidirectionalIterator rend (const Container &container)
 

Additional Inherited Members

- Static Public Member Functions inherited from BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >
static ConstBidirectionalIterator begin (const Container &container)
 
static ConstBidirectionalIterator end (const Container &container)
 
static ConstBidirectionalIterator rbegin (const Container &container)
 
static ConstBidirectionalIterator rend (const Container &container)
 
static ConstBidirectionalIterator begin (const Container &container)
 
static ConstBidirectionalIterator end (const Container &container)
 
static ConstBidirectionalIterator rbegin (const Container &container)
 
static ConstBidirectionalIterator rend (const Container &container)
 
- Static Public Member Functions inherited from BALL::ConstForwardIterator< Container, DataType, Position, Traits >
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::BidirectionalIterator< Container, DataType, Position, Traits >

Mutable bidirectional iterator.

Definition at line 258 of file CONCEPT/bidirectionalIterator.h.

Member Typedef Documentation

template<typename Container, typename DataType, typename Position, typename Traits>
typedef ConstBidirectionalIterator<Container, DataType, Position, Traits> BALL::BidirectionalIterator< Container, DataType, Position, Traits >::Base

Definition at line 272 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
typedef ConstBidirectionalIterator<Container, DataType, Position, Traits> BALL::BidirectionalIterator< Container, DataType, Position, Traits >::Base

Definition at line 288 of file MATHS/LINALG/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
typedef DataType* BALL::BidirectionalIterator< Container, DataType, Position, Traits >::pointer

Definition at line 270 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
typedef DataType* BALL::BidirectionalIterator< Container, DataType, Position, Traits >::pointer

Definition at line 286 of file MATHS/LINALG/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
typedef DataType& BALL::BidirectionalIterator< Container, DataType, Position, Traits >::reference

Definition at line 268 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
typedef DataType& BALL::BidirectionalIterator< Container, DataType, Position, Traits >::reference

Definition at line 284 of file MATHS/LINALG/bidirectionalIterator.h.

Constructor & Destructor Documentation

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE BALL::BidirectionalIterator< Container, DataType, Position, Traits >::BidirectionalIterator ( )
inline

Default constructor.

Definition at line 280 of file CONCEPT/bidirectionalIterator.h.

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

Copy constructor.

Definition at line 283 of file CONCEPT/bidirectionalIterator.h.

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

Destructor.

Definition at line 290 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType , typename Position , typename Traits >
BALL::BidirectionalIterator< Container, DataType, Position, Traits >::BidirectionalIterator ( const Container &  container)
protected

Construct an iterator bound to a specific container.

Definition at line 432 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL::BidirectionalIterator< Container, DataType, Position, Traits >::BidirectionalIterator ( )
inline

Default constructor.

Definition at line 296 of file MATHS/LINALG/bidirectionalIterator.h.

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

Copy constructor.

Definition at line 299 of file MATHS/LINALG/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL::BidirectionalIterator< Container, DataType, Position, Traits >::~BidirectionalIterator ( )
inline

Destructor.

Definition at line 305 of file MATHS/LINALG/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL::BidirectionalIterator< Container, DataType, Position, Traits >::BidirectionalIterator ( const Container &  container)
protected

Construct an iterator bound to a specific container.

Member Function Documentation

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

Return an iterator pointing to the first item of the container

Exceptions
Exception::Precondition

Definition at line 393 of file CONCEPT/bidirectionalIterator.h.

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

Return an iterator pointing to the first item of the container

Exceptions
Exception::Precondition
template<typename Container, typename DataType , typename Position , typename Traits >
BidirectionalIterator< Container, DataType, Position, Traits > BALL::BidirectionalIterator< Container, DataType, Position, Traits >::end ( const Container &  container)
static

Return an iterator pointing to the position after the last element

Exceptions
Exception::Precondition

Definition at line 403 of file CONCEPT/bidirectionalIterator.h.

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

Return an iterator pointing to the position after the last element

Exceptions
Exception::Precondition
template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE reference BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator* ( ) const
inline

Dereferentiation.

Definition at line 299 of file CONCEPT/bidirectionalIterator.h.

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

Dereferentiation.

Definition at line 314 of file MATHS/LINALG/bidirectionalIterator.h.

template<typename Container , typename DataType , typename Position , typename Traits >
BidirectionalIterator< Container, DataType, Position, Traits > & BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator++ ( )

Increment operator

Exceptions
Exception::Precondition

Definition at line 355 of file CONCEPT/bidirectionalIterator.h.

template<typename Container , typename DataType , typename Position , typename Traits >
BidirectionalIterator< Container, DataType, Position, Traits > BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator++ ( int  )

Postfix increment operator

Exceptions
Exception::Precondition

Definition at line 364 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BidirectionalIterator& BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator++ ( )

Increment operator

Exceptions
Exception::Precondition
template<typename Container, typename DataType, typename Position, typename Traits>
BidirectionalIterator BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator++ ( int  )

Postfix increment operator

Exceptions
Exception::Precondition
template<typename Container , typename DataType , typename Position , typename Traits >
BidirectionalIterator< Container, DataType, Position, Traits > & BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator-- ( )

Decrement operator

Exceptions
Exception::Precondition

Definition at line 374 of file CONCEPT/bidirectionalIterator.h.

template<typename Container , typename DataType , typename Position , typename Traits >
BidirectionalIterator< Container, DataType, Position, Traits > BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator-- ( int  )

Postfix decrement operator

Exceptions
Exception::Precondition

Definition at line 383 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BidirectionalIterator& BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator-- ( )

Decrement operator

Exceptions
Exception::Precondition
template<typename Container, typename DataType, typename Position, typename Traits>
BidirectionalIterator BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator-- ( int  )

Postfix decrement operator

Exceptions
Exception::Precondition
template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE pointer BALL::BidirectionalIterator< Container, DataType, Position, Traits >::operator-> ( ) const
inline

Pointer dereferentiation.

Definition at line 302 of file CONCEPT/bidirectionalIterator.h.

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

Pointer dereferentiation.

Definition at line 317 of file MATHS/LINALG/bidirectionalIterator.h.

template<typename Container, typename DataType , typename Position , typename Traits >
BidirectionalIterator< Container, DataType, Position, Traits > BALL::BidirectionalIterator< Container, DataType, Position, Traits >::rbegin ( const Container &  container)
static

Return an iterator pointing to the last element.

Exceptions
Exception::Precondition

Definition at line 413 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
static BidirectionalIterator BALL::BidirectionalIterator< Container, DataType, Position, Traits >::rbegin ( const Container &  container)
static

Return an iterator pointing to the last element.

Exceptions
Exception::Precondition
template<typename Container, typename DataType , typename Position , typename Traits >
BidirectionalIterator< Container, DataType, Position, Traits > BALL::BidirectionalIterator< Container, DataType, Position, Traits >::rend ( const Container &  container)
static

Return an iterator pointing to the positon before the first element

Exceptions
Exception::Precondition

Definition at line 423 of file CONCEPT/bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
static BidirectionalIterator BALL::BidirectionalIterator< Container, DataType, Position, Traits >::rend ( const Container &  container)
static

Return an iterator pointing to the positon before the first element

Exceptions
Exception::Precondition