IterableUGraphComponent Class Template Reference

#include <lemon/concepts/graph_components.h>

Inherits IterableGraphComponent< _Base >.

Inherited by IterableBpUGraphComponent.

Inheritance diagram for IterableUGraphComponent:

Inheritance graph
[legend]
List of all members.

Detailed Description

template<typename _Base = BaseUGraphComponent>
class lemon::concepts::IterableUGraphComponent< _Base >

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


Class based iteration

This interface provides functions for iteration on graph items

typedef GraphItemIt< Graph,
UEdge > 
UEdgeIt
 This iterator goes through each node.
typedef GraphIncIt< Graph,
UEdge, Node, 'u'> 
IncEdgeIt
 This iterator goes trough the incident edges 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 (UEdge &) const
 Gives back the first undirected edge in the iterating order.
void next (UEdge &) const
 Gives back the next undirected edge in the iterating order.
void firstInc (UEdge &, bool &, const Node &) const
 Gives back the first of the undirected edges from the given node.
void nextInc (UEdge &, bool &) const
 Gives back the next of the undirected edges from the given node.


Member Typedef Documentation

typedef GraphItemIt<Graph, UEdge> UEdgeIt

This iterator goes through each node.

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

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


Member Function Documentation

void first ( UEdge &   )  const [inline]

Gives back the first undirected edge in the iterating order.

void next ( UEdge &   )  const [inline]

Gives back the next undirected edge in the iterating order.

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

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

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

Gives back the next of the undirected 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.

Node runningNode ( const IncEdgeIt  )  const [inline]

Gives back the running node of the iterator.


The documentation for this class was generated from the following file:
Generated on Tue Oct 31 09:51:40 2006 for LEMON by  doxygen 1.5.1