StaticGraph Class Reference
[Graph Structure Concepts]

#include <lemon/concept/graph.h>

Inherited by ExtendableGraph.

Inheritance diagram for StaticGraph:

Inheritance graph
[legend]
List of all members.

Detailed Description

This class provides all the common features of a graph structure, however completely without implementations and real data structures behind the interface. All graph algorithms should compile with this class, but it will not run properly, of course.

It can be used for checking the interface compatibility, or it can serve as a skeleton of a new graph structure.

Also, you will find here the full documentation of a certain graph feature, the documentation of a real graph imlementation like ListGraph or SmartGraph will just refer to this structure.

Todo:
A pages describing the concept of concept description would be nice.


Public Types

typedef False UTag
 

Public Member Functions

 StaticGraph ()
 Defalult constructor.
Node target (Edge) const
 Gives back the target node of an edge.
Node source (Edge) const
 Gives back the source node of an edge.
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.

Classes

class  Edge
 The base type of the edge iterators. More...
class  EdgeIt
 This iterator goes through each edge. More...
class  EdgeMap
 Read write map of the edges to type T. More...
class  InEdgeIt
 This iterator goes trough the incoming edges of a node. More...
class  Node
 Copy consructor. More...
class  NodeIt
 This iterator goes through each node. More...
class  NodeMap
 Read write map of the nodes to type T. More...
class  OutEdgeIt
 This iterator goes trough the outgoing edges of a node. More...


Member Typedef Documentation

typedef False UTag
 

Todo:
undocumented


Constructor & Destructor Documentation

StaticGraph  )  [inline]
 

Defalult constructor.


Member Function Documentation

Node target Edge   )  const [inline]
 

Gives back the target node of an edge.

Node source Edge   )  const [inline]
 

Gives back the source node of an edge.

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 node on the given edge.


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