Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template find_iterator

boost::algorithm::find_iterator — find_iterator

Synopsis

// In header: <boost/algorithm/string/find_iterator.hpp>

template<typename IteratorT> 
class find_iterator : public  {
public:
  // construct/copy/destruct
  (find_iterator &);
  template<typename FinderT, typename RangeT> (, );

  // public member functions
   (find_iterator & = (find_iterator &, 
                            { );
   (, );
   ();
   () ;

  // private member functions
   () ;
   ();
   (find_iterator &) ;

  // public data members
   End;
   Finder;
};

Description

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.

find_iterator public construct/copy/destruct

  1. (find_iterator & Other);
    Default constructor.

    Construct null iterator. All null iterators are equal.

    Construct a copy of the find_iterator

    Postconditions:

    eof()==true Copy constructor

  2. template<typename FinderT, typename RangeT> 
      ( Col,  Finder);
    Constructor.

    Construct new find_iterator for a given finder and a range.

find_iterator public member functions

  1.  (find_iterator & operator = (find_iterator &, 
                              { );
    Copy assignment.

    Assigns a copy of the find_iterator Constructor

    Construct new find_iterator for a given finder and a range.

  2.  (, );
  3.  ();
  4.  () ;
    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.

find_iterator private member functions

  1.  () ;
  2.  ();
  3.  (find_iterator & Other) ;

PrevUpHomeNext