Path Class Template Reference
[Skeletons]

#include <path.h>

List of all members.


Detailed Description

template<typename GR>
class lemon::skeleton::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 41 of file skeletons/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

 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 head () const
 Starting point of the path.
GraphNode tail () const
 End point of the path.
template<typename It> It & first (It &i) const
 First NodeIt/EdgeIt.
NodeIt head (const EdgeIt &e) const
 The head of an edge.
NodeIt tail (const EdgeIt &e) const
 The tail of an edge.


Constructor & Destructor Documentation

Path const Graph _G  )  [inline]
 

Parameters:
_G The graph in which the path is.
Definition at line 55 of file skeletons/path.h.

References Path::Graph.


Member Function Documentation

GraphNode head  )  const [inline]
 

Starting point of the path. Returns INVALID if the path is empty. Definition at line 69 of file skeletons/path.h.

References Path::GraphNode, and lemon::INVALID.

GraphNode tail  )  const [inline]
 

End point of the path. Returns INVALID if the path is empty. Definition at line 74 of file skeletons/path.h.

References Path::GraphNode, and lemon::INVALID.

It& first It &  i  )  const [inline]
 

Initializes node or edge iterator to point to the first node or edge. Definition at line 81 of file skeletons/path.h.

NodeIt head const EdgeIt e  )  const [inline]
 

Returns node iterator pointing to the head node of the given edge iterator. Definition at line 87 of file skeletons/path.h.

References lemon::INVALID.

NodeIt tail const EdgeIt e  )  const [inline]
 

Returns node iterator pointing to the tail node of the given edge iterator. Definition at line 93 of file skeletons/path.h.

References lemon::INVALID.


The documentation for this class was generated from the following file:
Generated on Thu Sep 30 12:18:41 2004 for LEMON by doxygen 1.3.8