mln::doc::Iterator< E > Struct Template Reference

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

#include <iterator.hh>

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

List of all members.

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	next_ ()
	Go to the next element.
void	start ()
	Start an iteration.
Protected Member Functions
	Iterator ()

---

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.

---

Constructor & Destructor Documentation

template<typename E>

mln::doc::Iterator< E >::Iterator

(

)

[protected]

---

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 >::next_

(

)

Go to the next element.

Make the iterator jump from the current element to the next one. The current element is thus updated.

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.