tlp::Iterator< T > Struct Template Reference

#include <Iterator.h>

Inheritance diagram for tlp::Iterator< T >:

Public Member Functions
iterator_t	begin ()
iterator_t	end ()
virtual bool	hasNext ()=0
virtual T	next ()=0

Detailed Description

template<typename T>
struct tlp::Iterator< T >

Interface for Tulip iterators. Allows basic iteration operations only.

Below are some examples about how to use Tulip iterators in C++ code.

// graph is a pointer to a tlp::Graph instance

// shortest syntax using C++11 for range based loops
for (auto n : graph->getNodes()) {
  // do something with n
}

// legacy syntax using Tulip forEach macro
#include <tulip/ForEach.h>
tlp::node n;
forEach(n, graph->getNodes()) {
  // do something with n
}

// no syntactic sugar syntax (needs to explicitly delete the iterator
// after its use)
tlp::Iterator<tl::node> *nodesIt = graph->getNodes();
while (nodesIt->hasNext()) {
  tlp::node n = nodes->next();
  // do something with n
}
delete nodesIt;

Definition at line 43 of file Graph.h.

Member Function Documentation

hasNext()

template<typename T>

virtual bool tlp::Iterator< T >::hasNext ( )

pure virtual

Tells if the sequence is at its end.

Returns

bool Whether there are more elements to iterate.

Implemented in tlp::StableIterator< T >, tlp::StableIterator< tlp::node >, tlp::StableIterator< tlp::edge >, tlp::ConcatIterator< T >, tlp::FilterIterator< TYPE, FILTER >, tlp::ConversionIterator< TYPEIN, TYPEOUT, ConversionFunc >, tlp::ConversionIterator< TIN, TOUT, ConversionFunc >, and tlp::StlIterator< T, ITERATOR >.

Here is the caller graph for this function:

next()

template<typename T>

virtual T tlp::Iterator< T >::next ( )

pure virtual

Moves the Iterator on the next element.

Returns

The current element pointed by the Iterator.

Implemented in tlp::StableIterator< T >, tlp::StableIterator< tlp::node >, tlp::StableIterator< tlp::edge >, tlp::ConversionIterator< TYPEIN, TYPEOUT, ConversionFunc >, tlp::ConversionIterator< TIN, TOUT, ConversionFunc >, tlp::FilterIterator< TYPE, FILTER >, tlp::ConcatIterator< T >, and tlp::StlIterator< T, ITERATOR >.

Here is the caller graph for this function: