GGL    Boost C++ Libraries

ggl::ever_circling_iterator< Iterator > Struct Template Reference

Iterator which ever circles through a range. More...

List of all members.

Public Member Functions

 ever_circling_iterator (Iterator begin, Iterator end, Iterator start)
 ever_circling_iterator (Iterator begin, Iterator end)
void moveto (Iterator it)

Friends

class boost::iterator_core_access


Detailed Description

template<typename Iterator>
struct ggl::ever_circling_iterator< Iterator >

Iterator which ever circles through a range.

Template Parameters:
Iterator iterator on which this class is based on
If the iterator arrives at range.end() it restarts from the beginning. So it has to be stopped in another way. Don't call for(....; it++) because it will turn in an endless loop
Note:
Name inspired on David Bowie's "Chant Of The Ever Circling Skeletal Family"

Definition at line 32 of file ever_circling_iterator.hpp.


Constructor & Destructor Documentation

template<typename Iterator >
ggl::ever_circling_iterator< Iterator >::ever_circling_iterator ( Iterator  begin,
Iterator  end 
) [explicit]

Definition at line 41 of file ever_circling_iterator.hpp.

template<typename Iterator >
ggl::ever_circling_iterator< Iterator >::ever_circling_iterator ( Iterator  begin,
Iterator  end,
Iterator  start 
) [explicit]

Definition at line 48 of file ever_circling_iterator.hpp.


Member Function Documentation

template<typename Iterator >
void ggl::ever_circling_iterator< Iterator >::moveto ( Iterator  it  ) 

Navigate to a certain position, should be in [start .. end], it at end it will circle again.

Definition at line 57 of file ever_circling_iterator.hpp.


Friends And Related Function Documentation

template<typename Iterator >
friend class boost::iterator_core_access [friend]

Definition at line 39 of file ever_circling_iterator.hpp.


November 5, 2009

Copyright © 1995-2009 Barend Gehrels, Geodan, Amsterdam
Copyright © 2008-2009 Bruno Lalande, Paris
Copyright © 2009 Mateusz Loskot, Cadcorp, London
Documentation is generated by Doxygen