BALL  1.4.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
BALL::ConstForwardFilterIterator< Predicate, IteratorForward > Class Template Reference

#include <BALL/MATHS/LINALG/forwardFilterIterator.h>

Inheritance diagram for BALL::ConstForwardFilterIterator< Predicate, IteratorForward >:
BALL::BaseFilterIterator< Predicate, IteratorForward > BALL::ForwardFilterIterator< Predicate, IteratorForward >

Public Types

Typedefs
typedef
IteratorForward::container_type 
Container
typedef IteratorForward::value_type DataType
typedef
IteratorForward::difference_type 
Position
typedef
IteratorForward::traits_type 
Traits
typedef IteratorForward::value_type value_type
typedef
IteratorForward::difference_type 
difference_type
typedef IteratorForward::pointer pointer
typedef IteratorForward::reference reference
typedef std::forward_iterator_tag iterator_category
typedef BaseFilterIterator
< Predicate, IteratorForward
Base
- Public Types inherited from BALL::BaseFilterIterator< Predicate, IteratorForward >
typedef
IteratorForward::container_type 
Container
typedef IteratorForward::value_type DataType
typedef
IteratorForward::difference_type 
Position
typedef
IteratorForward::traits_type 
Traits
typedef IteratorForward::value_type value_type
typedef
IteratorForward::difference_type 
difference_type
typedef IteratorForward::pointer pointer
typedef IteratorForward::reference reference
typedef std::input_iterator_tag iterator_category

Public Member Functions

void setIterator (const IteratorForward &iterator)
 Set the internal iterator.
const IteratorForwardgetIterator () const
 Get a constant reference to the internal iterator.
IteratorForwardgetIterator ()
 Get a constant reference to the internal iterator.
Constructors and Destructors
 ConstForwardFilterIterator ()
 Default constructor.
 ConstForwardFilterIterator (Predicate p, IteratorForward it)
 ConstForwardFilterIterator (const ConstForwardFilterIterator &iterator)
 Copy constructor.
 ~ConstForwardFilterIterator ()
Assignment
ConstForwardFilterIteratoroperator= (const ConstForwardFilterIterator &iterator)
void swap (ConstForwardFilterIterator &iterator)
- Public Member Functions inherited from BALL::BaseFilterIterator< Predicate, IteratorForward >
 BaseFilterIterator ()
 Default constructor.
 BaseFilterIterator (Predicate p, IteratorForwardit)
 Default constructor.
 BaseFilterIterator (const BaseFilterIterator &iterator)
 Copy constructor.
 ~BaseFilterIterator ()
 Destructor.
BaseFilterIteratoroperator= (const BaseFilterIterator &iterator)
void swap (BaseFilterIterator &iterator)
 Swap two iterators.
void invalidate ()
 Invalidate the iterator.
void setTraits (const Traits &traits)
 Set the traits.
const TraitsgetTraits () const
 Get a constant reference to the traits of this iterator.
TraitsgetTraits ()
 Get a constant reference to the traits of this iterator.
void setPredicate (const Predicate &predicate)
 Set the predicates.
const Predicate & getPredicate () const
 Get a constant reference to the traits of this iterator.
Predicate & getPredicate ()
 Get a constant reference to the traits of this iterator.
const ContainergetContainer () const
 Get a constant pointer to the container of this iterator.
 operator const Position & () const
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.
bool operator== (const BaseFilterIterator &iterator) const
 Equality operator.
bool operator== (const IteratorForward &iterator) const
 Equality operator.
bool operator!= (const BaseFilterIterator &iterator) const
 Inequality operator.
bool operator!= (const IteratorForward &iterator) const
 Inequality operator.
bool isSingular () const
bool isValid () const
bool operator+ () const
 Validity predicate.
bool operator- () const
 Invalidity predicate.

Protected Member Functions

template<typename Container >
 ConstForwardFilterIterator (const Container &container)
- Protected Member Functions inherited from BALL::BaseFilterIterator< Predicate, IteratorForward >
 BaseFilterIterator (const Container &container)

Iterator methods

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

Additional Inherited Members

- Public Attributes inherited from BALL::BaseFilterIterator< Predicate, IteratorForward >
Predicate predicate_
 The instance of the iterator and the predicate.
IteratorForward iterator_

Detailed Description

template<class Predicate, class IteratorForward>
class BALL::ConstForwardFilterIterator< Predicate, IteratorForward >

Generic non-mutable forward iterator

Definition at line 18 of file forwardFilterIterator.h.

Member Typedef Documentation

template<class Predicate, class IteratorForward>
typedef BaseFilterIterator<Predicate, IteratorForward> BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::Base

Definition at line 47 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::container_type BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::Container

Definition at line 29 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::value_type BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::DataType

Definition at line 31 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::difference_type BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::difference_type

Definition at line 39 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef std::forward_iterator_tag BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::iterator_category

Definition at line 45 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::pointer BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::pointer

Definition at line 41 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::difference_type BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::Position

Definition at line 33 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::reference BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::reference

Definition at line 43 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::traits_type BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::Traits

Definition at line 35 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
typedef IteratorForward::value_type BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::value_type

Definition at line 37 of file forwardFilterIterator.h.

Constructor & Destructor Documentation

template<class Predicate, class IteratorForward>
BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::ConstForwardFilterIterator ( )
inline

Default constructor.

Definition at line 55 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::ConstForwardFilterIterator ( Predicate  p,
IteratorForward  it 
)
inline

Definition at line 58 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::ConstForwardFilterIterator ( const ConstForwardFilterIterator< Predicate, IteratorForward > &  iterator)
inline

Copy constructor.

Definition at line 66 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::~ConstForwardFilterIterator ( )
inline

Definition at line 72 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
template<typename Container >
BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::ConstForwardFilterIterator ( const Container container)
inlineprotected

Definition at line 177 of file forwardFilterIterator.h.

Member Function Documentation

template<class Predicate , class IteratorForward >
ConstForwardFilterIterator< Predicate, IteratorForward > BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::begin ( const Container container)
static
template<class Predicate , class IteratorForward >
ConstForwardFilterIterator< Predicate, IteratorForward > BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::end ( const Container container)
static
template<class Predicate, class IteratorForward>
const IteratorForward& BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::getIterator ( ) const
inline

Get a constant reference to the internal iterator.

Definition at line 104 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
IteratorForward& BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::getIterator ( )
inline

Get a constant reference to the internal iterator.

Definition at line 107 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
bool BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::isBegin ( ) const

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

Reimplemented in BALL::ConstBidirectionalFilterIterator< Predicate, IteratorBidirectional >, and BALL::ConstBidirectionalFilterIterator< Predicate, IteratorRandomAccess >.

Definition at line 206 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
bool BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::isEnd ( ) const

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

Reimplemented in BALL::ConstBidirectionalFilterIterator< Predicate, IteratorBidirectional >, and BALL::ConstBidirectionalFilterIterator< Predicate, IteratorRandomAccess >.

Definition at line 236 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
ConstForwardFilterIterator& BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::operator++ ( )
inline
template<class Predicate, class IteratorForward>
ConstForwardFilterIterator BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::operator++ ( int  )
inline
template<class Predicate, class IteratorForward>
ConstForwardFilterIterator& BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::operator= ( const ConstForwardFilterIterator< Predicate, IteratorForward > &  iterator)
inline

Definition at line 80 of file forwardFilterIterator.h.

template<class Predicate, class IteratorForward>
void BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::setIterator ( const IteratorForward iterator)
inline
template<class Predicate, class IteratorForward>
void BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::swap ( ConstForwardFilterIterator< Predicate, IteratorForward > &  iterator)
inline

Definition at line 87 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
void BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::toBegin ( )

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

Exceptions
Exception::SingularIteratorif the iterator is singular

Reimplemented in BALL::ConstBidirectionalFilterIterator< Predicate, IteratorBidirectional >, and BALL::ConstBidirectionalFilterIterator< Predicate, IteratorRandomAccess >.

Definition at line 186 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
void BALL::ConstForwardFilterIterator< Predicate, IteratorForward >::toEnd ( )

Move the iterator behind the last item of the container

Exceptions
Exception::SingularIteratorif the iterator is singular

Reimplemented in BALL::ConstBidirectionalFilterIterator< Predicate, IteratorBidirectional >, and BALL::ConstBidirectionalFilterIterator< Predicate, IteratorRandomAccess >.

Definition at line 216 of file forwardFilterIterator.h.