IterableGraphComponent Class Reference

#include <lemon/concept/graph_component.h>

Inherits BaseGraphComponent.

Inherited by _StaticGraph.

Inheritance diagram for IterableGraphComponent:

Inheritance graph
[legend]
List of all members.

Detailed Description

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


Public Types

typedef GraphIterator< Graph,
Node
NodeIt
 This iterator goes through each node.
typedef GraphIterator< Graph,
Edge
EdgeIt
 This iterator goes through each node.
typedef GraphIncIterator<
Graph, Edge, 'i'> 
InEdgeIt
 This iterator goes trough the incoming edges of a node.
typedef GraphIncIterator<
Graph, Edge, 'o'> 
OutEdgeIt
 This iterator goes trough the outgoing edges of a node.

Public Member Functions

Node baseNode (const InEdgeIt &) const
 The base node of the iterator.
Node runningNode (const InEdgeIt &) const
 The running node of the iterator.
Node baseNode (const OutEdgeIt &) const
 The base node of the iterator.
Node runningNode (const OutEdgeIt &) const
 The running node of the iterator.
Node oppositeNode (const Node &, const Edge &) const
 The opposite node on the given edge.


Member Typedef Documentation

typedef GraphIterator<Graph, Node> NodeIt
 

This iterator goes through each node.

typedef GraphIterator<Graph, Edge> EdgeIt
 

This iterator goes through each node.

typedef GraphIncIterator<Graph, Edge, 'i'> InEdgeIt
 

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

typedef GraphIncIterator<Graph, Edge, 'o'> OutEdgeIt
 

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


Member Function Documentation

Node baseNode const InEdgeIt  )  const [inline]
 

Gives back the base node of the iterator. It is always the target of the pointed edge.

Node runningNode const InEdgeIt  )  const [inline]
 

Gives back the running node of the iterator. It is always the source of the pointed edge.

Node baseNode const OutEdgeIt  )  const [inline]
 

Gives back the base node of the iterator. It is always the source of the pointed edge.

Node runningNode const OutEdgeIt  )  const [inline]
 

Gives back the running node of the iterator. It is always the target of the pointed edge.

Node oppositeNode const Node ,
const Edge
const [inline]
 

Gives back the opposite on the given edge.

Todo:
It should not be here.


The documentation for this class was generated from the following file:
Generated on Fri Feb 3 18:43:47 2006 for LEMON by  doxygen 1.4.6