Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::doc::Iterator< E > Struct Template Reference

Documentation class for mln::Iterator. More...

#include <iterator.hh>

Inheritance diagram for mln::doc::Iterator< E >:
Inheritance graph

Public Member Functions

void invalidate ()
 Invalidate the iterator.
 
bool is_valid () const
 Returns true if the iterator is valid, that is, designates an element.
 
void start ()
 Start an iteration.
 

Detailed Description

template<typename E>
struct mln::doc::Iterator< E >

Documentation class for mln::Iterator.

See Also
mln::Iterator

Definition at line 36 of file doc/iterator.hh.

Member Function Documentation

template<typename E >
void mln::doc::Iterator< E >::invalidate ( )

Invalidate the iterator.

template<typename E >
bool mln::doc::Iterator< E >::is_valid ( ) const

Returns true if the iterator is valid, that is, designates an element.

template<typename E >
void mln::doc::Iterator< E >::start ( )

Start an iteration.

Make the iterator designate the first element if it exists. If this first element does not exist, the iterator is not valid.