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

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

Inheritance diagram for BALL::ForwardFilterIterator< Predicate, IteratorForward >:
BALL::ConstForwardFilterIterator< Predicate, IteratorForward > BALL::BaseFilterIterator< 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
ConstForwardFilterIterator
< Predicate, IteratorForward
Base
- Public Types inherited from BALL::ConstForwardFilterIterator< 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::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

Constructors and Destructors
 ForwardFilterIterator ()
 ForwardFilterIterator (Predicate p, IteratorForward it)
 ForwardFilterIterator (const ForwardFilterIterator &iterator)
 ~ForwardFilterIterator ()
Assignemnt
ForwardFilterIteratoroperator= (const ForwardFilterIterator &iterator)
void swap (ForwardFilterIterator &iterator)
- Public Member Functions inherited from BALL::ConstForwardFilterIterator< Predicate, IteratorForward >
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.
 ConstForwardFilterIterator ()
 Default constructor.
 ConstForwardFilterIterator (Predicate p, IteratorForward it)
 ConstForwardFilterIterator (const ConstForwardFilterIterator &iterator)
 Copy constructor.
 ~ConstForwardFilterIterator ()
ConstForwardFilterIteratoroperator= (const ConstForwardFilterIterator &iterator)
void swap (ConstForwardFilterIterator &iterator)
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.
- 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
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

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

Iterator methods

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.
ForwardFilterIteratoroperator++ ()
ForwardFilterIterator operator++ (int)
static ForwardFilterIterator begin (const Container &container)
static ForwardFilterIterator end (const Container &container)

Additional Inherited Members

- Static Public Member Functions inherited from BALL::ConstForwardFilterIterator< Predicate, IteratorForward >
- 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::ForwardFilterIterator< Predicate, IteratorForward >

Generic mutable forward iterator class

Definition at line 248 of file forwardFilterIterator.h.

Member Typedef Documentation

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

Definition at line 274 of file forwardFilterIterator.h.

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

Definition at line 258 of file forwardFilterIterator.h.

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

Definition at line 260 of file forwardFilterIterator.h.

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

Definition at line 268 of file forwardFilterIterator.h.

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

Definition at line 270 of file forwardFilterIterator.h.

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

Definition at line 262 of file forwardFilterIterator.h.

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

Definition at line 272 of file forwardFilterIterator.h.

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

Definition at line 264 of file forwardFilterIterator.h.

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

Definition at line 266 of file forwardFilterIterator.h.

Constructor & Destructor Documentation

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

Definition at line 283 of file forwardFilterIterator.h.

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

Definition at line 286 of file forwardFilterIterator.h.

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

Definition at line 292 of file forwardFilterIterator.h.

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

Definition at line 298 of file forwardFilterIterator.h.

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

Definition at line 383 of file forwardFilterIterator.h.

Member Function Documentation

template<class Predicate , class IteratorForward >
ForwardFilterIterator< Predicate, IteratorForward > BALL::ForwardFilterIterator< Predicate, IteratorForward >::begin ( const Container container)
static

Return an iterator pointing to the beginning of the container

Exceptions
Exception::Precondition

Reimplemented from BALL::ConstForwardFilterIterator< Predicate, IteratorForward >.

Definition at line 392 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
ForwardFilterIterator< Predicate, IteratorForward > BALL::ForwardFilterIterator< Predicate, IteratorForward >::end ( const Container container)
static

Return an iterator pointing at the end of the container

Exceptions
Exception::Precondition

Reimplemented from BALL::ConstForwardFilterIterator< Predicate, IteratorForward >.

Definition at line 401 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
reference BALL::ForwardFilterIterator< Predicate, IteratorForward >::operator* ( ) const
inline

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

Reimplemented from BALL::BaseFilterIterator< Predicate, IteratorForward >.

Definition at line 336 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
ForwardFilterIterator& BALL::ForwardFilterIterator< Predicate, IteratorForward >::operator++ ( )
inline

Increment operator

Exceptions
Exception::InvalidIterator

Reimplemented from BALL::ConstForwardFilterIterator< Predicate, IteratorForward >.

Definition at line 350 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
ForwardFilterIterator BALL::ForwardFilterIterator< Predicate, IteratorForward >::operator++ ( int  )
inline

Postfix increment operator

Exceptions
Exception::InvalidIterator

Reimplemented from BALL::ConstForwardFilterIterator< Predicate, IteratorForward >.

Definition at line 366 of file forwardFilterIterator.h.

template<class Predicate , class IteratorForward >
pointer BALL::ForwardFilterIterator< Predicate, IteratorForward >::operator-> ( ) const
inline

Return a pointer to the current data.

Reimplemented from BALL::BaseFilterIterator< Predicate, IteratorForward >.

Definition at line 342 of file forwardFilterIterator.h.

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

Definition at line 305 of file forwardFilterIterator.h.

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

Definition at line 314 of file forwardFilterIterator.h.