IterableGraphComponent Class Template Reference

#include <lemon/concepts/graph_components.h>

Inheritance diagram for IterableGraphComponent:

Inheritance graph
[legend]

List of all members.


Detailed Description

template<typename _Base = BaseGraphComponent>
class lemon::concepts::IterableGraphComponent< _Base >

This class provides beside the core graph features iterator based iterable interface for the undirected graph structure. This concept is part of the Graph concept.

Class based iteration

This interface provides functions for iteration on graph items

typedef GraphItemIt< Graph, Edge > EdgeIt
 This iterator goes through each node.
typedef GraphIncIt< Graph,
Edge, Node, 'u'> 
IncEdgeIt
 This iterator goes trough the incident arcs of a node.
Node baseNode (const IncEdgeIt &) const
 The base node of the iterator.
Node runningNode (const IncEdgeIt &) const
 The running node of the iterator.

Public Member Functions

Base iteration
This interface provides functions for iteration on graph items

void first (Edge &) const
 Gives back the first edge in the iterating order.
void next (Edge &) const
 Gives back the next edge in the iterating order.
void firstInc (Edge &, bool &, const Node &) const
 Gives back the first of the edges from the given node.
void nextInc (Edge &, bool &) const
 Gives back the next of the edges from the given node.

Member Typedef Documentation

typedef GraphItemIt<Graph, Edge> EdgeIt

This iterator goes through each node.

typedef GraphIncIt<Graph, Edge, Node, 'u'> IncEdgeIt

This iterator goes trough the incident arcs of a certain node of a graph.


Member Function Documentation

void first ( Edge &   )  const [inline]

Gives back the first edge in the iterating order.

void next ( Edge &   )  const [inline]

Gives back the next edge in the iterating order.

void firstInc ( Edge &  ,
bool &  ,
const Node &   
) const [inline]

Gives back the first of the edges from the given node. The bool parameter gives back that direction which gives a good direction of the edge so the source of the directed arc is the given node.

void nextInc ( Edge &  ,
bool &   
) const [inline]

Gives back the next of the edges from the given node. The bool parameter should be used as the firstInc() use it.

Node baseNode ( const IncEdgeIt  )  const [inline]

Gives back the base node of the iterator.

Reimplemented from IterableDigraphComponent.

Node runningNode ( const IncEdgeIt  )  const [inline]

Gives back the running node of the iterator.

Reimplemented from IterableDigraphComponent.


The documentation for this class was generated from the following file:

Generated on Fri Jan 23 18:15:22 2009 for LEMON by  doxygen 1.5.6