bitrl::FilteredIterator< PREDICATE, TYPE > Class Template Reference

Simple wrapper to boost::filter_iterator. More...

#include <filtered_iterator.h>

Public Types
typedef PREDICATE	predicate
typedef TYPE	iterator_type
typedef boost::filter_iterator< PREDICATE, TYPE >	iterator_t
typedef iterator_t::value_type	value_type

Public Member Functions
	FilteredIterator ()
	default constructor
	FilteredIterator (predicate p, iterator_type begin, iterator_type end)
	construct by passing in the predicate and the range over which we iterate
	FilteredIterator (iterator_type begin, iterator_type end)
	construct by passing in the predicate and the range over which we iterate
	FilteredIterator (const FilteredIterator &o)
	copy cotor
virtual	~FilteredIterator ()
	Destructor.
FilteredIterator &	operator++ ()
	op++ simply increment the boost::filter_iterator
FilteredIterator	operator++ (int)
	++op simply increment the boost::filter_iterator
iterator_t	get_iterator ()
	Return the underlying boost iterator.
value_type	operator* () const
	Dereference the iterator.

Friends
template<typename Pred , typename Type >
bool	operator== (const FilteredIterator< Pred, Type > &lhs, const FilteredIterator< Pred, Type > &rhs)

Detailed Description

template<typename PREDICATE, typename TYPE>
class bitrl::FilteredIterator< PREDICATE, TYPE >

Simple wrapper to boost::filter_iterator.

Member Typedef Documentation

iterator_t

template<typename PREDICATE , typename TYPE >

typedef boost::filter_iterator<PREDICATE, TYPE> bitrl::FilteredIterator< PREDICATE, TYPE >::iterator_t

iterator_type

template<typename PREDICATE , typename TYPE >

typedef TYPE bitrl::FilteredIterator< PREDICATE, TYPE >::iterator_type

predicate

template<typename PREDICATE , typename TYPE >

typedef PREDICATE bitrl::FilteredIterator< PREDICATE, TYPE >::predicate

value_type

template<typename PREDICATE , typename TYPE >

typedef iterator_t::value_type bitrl::FilteredIterator< PREDICATE, TYPE >::value_type

Constructor & Destructor Documentation

FilteredIterator() [1/4]

template<typename PREDICATE , typename TYPE >

bitrl::FilteredIterator< PREDICATE, TYPE >::FilteredIterator

(

)

default constructor

FilteredIterator() [2/4]

template<typename PREDICATE , typename TYPE >

bitrl::FilteredIterator< PREDICATE, TYPE >::FilteredIterator	(	predicate	p,
		iterator_type	begin,
		iterator_type	end
	)

construct by passing in the predicate and the range over which we iterate

FilteredIterator() [3/4]

template<typename PREDICATE , typename TYPE >

bitrl::FilteredIterator< PREDICATE, TYPE >::FilteredIterator	(	iterator_type	begin,
		iterator_type	end
	)

construct by passing in the predicate and the range over which we iterate

FilteredIterator() [4/4]

template<typename PREDICATE , typename TYPE >

bitrl::FilteredIterator< PREDICATE, TYPE >::FilteredIterator

(

const FilteredIterator< PREDICATE, TYPE > &

o

)

copy cotor

~FilteredIterator()

template<typename PREDICATE , typename TYPE >

virtual bitrl::FilteredIterator< PREDICATE, TYPE >::~FilteredIterator ( )

inlinevirtual

Destructor.

Member Function Documentation

get_iterator()

template<typename PREDICATE , typename TYPE >

iterator_t bitrl::FilteredIterator< PREDICATE, TYPE >::get_iterator ( )

inline

Return the underlying boost iterator.

operator*()

template<typename PREDICATE , typename TYPE >

value_type bitrl::FilteredIterator< PREDICATE, TYPE >::operator* ( ) const

inline

Dereference the iterator.

operator++() [1/2]

template<typename PREDICATE , typename TYPE >

FilteredIterator< PREDICATE, TYPE > & bitrl::FilteredIterator< PREDICATE, TYPE >::operator++

(

)

op++ simply increment the boost::filter_iterator

operator++() [2/2]

template<typename PREDICATE , typename TYPE >

FilteredIterator< PREDICATE, TYPE > bitrl::FilteredIterator< PREDICATE, TYPE >::operator++

(

int

)

++op simply increment the boost::filter_iterator

Friends And Related Symbol Documentation

operator==

template<typename PREDICATE , typename TYPE >

template<typename Pred , typename Type >

bool operator== ( const FilteredIterator< Pred, Type > &  lhs, const FilteredIterator< Pred, Type > &  rhs  )

friend

---

The documentation for this class was generated from the following file:

• libs/bitrl/src/bitrl/utils/filtered_iterator.h