Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Path Class Template Reference
[Concepts]

#include <lemon/concept/path.h>

List of all members.


Detailed Description

template<typename GR>
class lemon::concept::Path< GR >

A skeleton structure for representing directed paths in a graph.
Parameters:
GR The graph type in which the path is.
In a sense, the path can be treated as a graph, for it has NodeIt and EdgeIt with the same usage. These types converts to the Node and Edge of the original graph.


Public Types

typedef GR Graph
 Type of the underlying graph.
typedef Graph::Edge GraphEdge
 Edge type of the underlying graph.
typedef Graph::Node GraphNode
 Node type of the underlying graph.

Public Member Functions

 Path (const Graph &_g)
int length () const
 Length of the path.
bool empty () const
 Returns whether the path is empty.
void clear ()
 Resets the path to an empty path.
GraphNode target () const
 Starting point of the path.
GraphNode source () const
 End point of the path.
template<typename It>
It & first (It &i) const
 First NodeIt/EdgeIt.
NodeIt target (const EdgeIt &) const
 The target of an edge.
NodeIt source (const EdgeIt &) const
 The source of an edge.

Classes

class  Builder
 Class to build paths. More...
class  EdgeIt
 Iterator class to iterate on the edges of the paths. More...
class  NodeIt
 Iterator class to iterate on the nodes of the paths. More...


Constructor & Destructor Documentation

Path const Graph _g  )  [inline]
 

Parameters:
_g The graph in which the path is.


Member Function Documentation

GraphNode target  )  const [inline]
 

Starting point of the path. Returns INVALID if the path is empty.

GraphNode source  )  const [inline]
 

End point of the path. Returns INVALID if the path is empty.

It& first It &  i  )  const [inline]
 

Initializes node or edge iterator to point to the first node or edge.

NodeIt target const EdgeIt  )  const [inline]
 

Returns node iterator pointing to the target node of the given edge iterator.

NodeIt source const EdgeIt  )  const [inline]
 

Returns node iterator pointing to the source node of the given edge iterator.


The documentation for this class was generated from the following file:
Generated on Sat Aug 27 14:16:58 2005 for LEMON by  doxygen 1.4.4