Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::algorithm::find_iterator< IteratorT > Class Template Reference

find_iterator More...

#include <find_iterator.hpp>

Inheritance diagram for boost::algorithm::find_iterator< IteratorT >:
Collaboration diagram for boost::algorithm::find_iterator< IteratorT >:

Public Member Functions

 find_iterator ()
 Default constructor. More...
 
 find_iterator (const find_iterator &Other)
 Copy constructor. More...
 
template<typename FinderT >
 find_iterator (IteratorT Begin, IteratorT End, FinderT Finder)
 Constructor. More...
 
template<typename FinderT , typename RangeT >
 find_iterator (RangeT &Col, FinderT Finder)
 Constructor. More...
 
bool eof () const
 Eof check. More...
 

Friends

class ::boost::iterator_core_access
 

Detailed Description

template<typename IteratorT>
class boost::algorithm::find_iterator< IteratorT >

find_iterator

Find iterator encapsulates a Finder and allows for incremental searching in a string. Each increment moves the iterator to the next match.

Find iterator is a readable forward traversal iterator.

Dereferencing the iterator yields an iterator_range delimiting the current match.

Constructor & Destructor Documentation

template<typename IteratorT >
boost::algorithm::find_iterator< IteratorT >::find_iterator ( )
inline

Default constructor.

Construct null iterator. All null iterators are equal.

Postcondition
eof()==true
template<typename IteratorT >
boost::algorithm::find_iterator< IteratorT >::find_iterator ( const find_iterator< IteratorT > &  Other)
inline

Copy constructor.

Construct a copy of the find_iterator

template<typename IteratorT >
template<typename FinderT >
boost::algorithm::find_iterator< IteratorT >::find_iterator ( IteratorT  Begin,
IteratorT  End,
FinderT  Finder 
)
inline

Constructor.

Construct new find_iterator for a given finder and a range.

template<typename IteratorT >
template<typename FinderT , typename RangeT >
boost::algorithm::find_iterator< IteratorT >::find_iterator ( RangeT &  Col,
FinderT  Finder 
)
inline

Constructor.

Construct new find_iterator for a given finder and a range.

References boost::as_literal(), boost::asio::begin, boost::asio::end, and boost::make_iterator_range().

Member Function Documentation

template<typename IteratorT >
bool boost::algorithm::find_iterator< IteratorT >::eof ( ) const
inline

Eof check.

Check the eof condition. Eof condition means that there is nothing more to be searched i.e. find_iterator is after the last match.

References boost::is_null().

Friends And Related Function Documentation

template<typename IteratorT >
friend class ::boost::iterator_core_access
friend

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