Path::Builder Class Reference

#include <lemon/path.h>

List of all members.


Detailed Description

template<typename Graph>
class lemon::Path< Graph >::Builder

This class is used to fill a path with edges.

You can push new edges to the front and to the back of the path in arbitrary order then you should commit these changes to the graph.

Fundamentally, for most "Paths" (classes fulfilling the PathConcept) while the builder is active (after the first modifying operation and until the commit()) the original Path is in a "transitional" state (operations on it have undefined result). But in the case of Path the original path remains unchanged until the commit. However we don't recomend that you use this feature.


Public Member Functions

 Builder (Path &_path)
 Constructor.
 ~Builder ()
 Destructor.
void setStartNode (const Node &_start)
 Sets the starting node of the path.
void pushFront (const Edge &e)
 Push a new edge to the front of the path.
void pushBack (const Edge &e)
 Push a new edge to the back of the path.
void commit ()
 Commit the changes to the path.
void reserveFront (size_t r)
 Reserve storage for the builder in advance.
void reserveBack (size_t r)
 Reserve storage for the builder in advance.


Constructor & Destructor Documentation

Builder ( Path _path  )  [inline]

Constructor

Parameters:
_path the path you want to fill in.

~Builder (  )  [inline]

Destructor


Member Function Documentation

void setStartNode ( const Node _start  )  [inline]

Sets the starting node of the path. Edge added to the path afterwards have to be incident to this node. It should be called if and only if the path is empty and before any call to pushFront() or pushBack()

void pushFront ( const Edge e  )  [inline]

Push a new edge to the front of the path.

See also:
setStartNode

void pushBack ( const Edge e  )  [inline]

Push a new edge to the back of the path.

See also:
setStartNode

void commit (  )  [inline]

Commit the changes to the path.

void reserveFront ( size_t  r  )  [inline]

If you know a reasonable upper bound of the number of the edges to add to the front, using this function you can speed up the building.

void reserveBack ( size_t  r  )  [inline]

If you know a reasonable upper bound of the number of the edges to add to the back, using this function you can speed up the building.


The documentation for this class was generated from the following file:
Generated on Tue Oct 31 09:51:18 2006 for LEMON by  doxygen 1.5.1