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 is has NodeIt and EdgeIt with the same usage. These types converts to the Node and Edge of the original graph.

Definition at line 43 of file path.h.

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

class Path (const Graph &_G)
size_t 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 &e) const
 The target of an edge.
NodeIt source (const EdgeIt &e) 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

class class Path const Graph _G  )  [inline]
 

Parameters:
_G The graph in which the path is.

Definition at line 57 of file path.h.


Member Function Documentation

GraphNode target  )  const [inline]
 

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

Definition at line 71 of file path.h.

GraphNode source  )  const [inline]
 

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

Definition at line 76 of file path.h.

It& first It &  i  )  const [inline]
 

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

Definition at line 83 of file path.h.

NodeIt target const EdgeIt e  )  const [inline]
 

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

Definition at line 89 of file path.h.

NodeIt source const EdgeIt e  )  const [inline]
 

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

Definition at line 95 of file path.h.


The documentation for this class was generated from the following file:
Generated on Sat Mar 19 10:59:01 2005 for LEMON by  doxygen 1.4.1