DagShortestPathWizard Class Template Reference

#include <lemon/dag_shortest_path.h>

List of all members.


Detailed Description

template<class _Traits>
class lemon::DagShortestPathWizard< _Traits >

This class is created to make it easier to use DagShortestPath algorithm. It uses the functions and features of the plain DagShortestPath, but it is much simpler to use it.

Simplicity means that the way to change the types defined in the traits class is based on functions that returns the new class and not on templatable built-in classes. When using the plain DagShortestPath the new class with the modified type comes from the original class by using the :: operator. In the case of DagShortestPathWizard only a function have to be called and it will return the needed class.

It does not have own run method. When its run method is called it initiates a plain DagShortestPath class, and calls the DagShortestPath::run() method of it.


Public Member Functions

 DagShortestPathWizard ()
 Constructor.
 DagShortestPathWizard (const Graph &graph, const LengthMap &length, Node source=INVALID)
 Constructor that requires parameters.
 DagShortestPathWizard (const _Traits &b)
 Copy constructor.
void run ()
 Runs DagShortestPath algorithm from a given node.
void run (Node source)
 Runs DagShortestPath algorithm from the given node.
template<class T>
DagShortestPathWizard< DefPredMapBase<
T > > 
predMap (const T &t)
 Named parameter function for setting PredMap type
template<class T>
DagShortestPathWizard< DefDistMapBase<
T > > 
distMap (const T &t)
 Named parameter function for setting DistMap type
template<class T>
DagShortestPathWizard< DefOperationTraitsBase<
T > > 
distMap ()
 Named parameter function for setting OperationTraits type
DagShortestPathWizard< _Traits > & source (Node source)
 Sets the source node, from which the DagShortestPath algorithm runs.


Constructor & Destructor Documentation

DagShortestPathWizard const Graph &  graph,
const LengthMap &  length,
Node  source = INVALID
[inline]
 

Constructor that requires parameters. These parameters will be the default values for the traits class.


Member Function Documentation

void run  )  [inline]
 

Runs DagShortestPath algorithm from a given node. The node can be given by the source function.

void run Node  source  )  [inline]
 

Runs DagShortestPath algorithm from the given node.

Parameters:
source is the given source.

DagShortestPathWizard<DefPredMapBase<T> > predMap const T &  t  )  [inline]
 

Named parameter function for setting PredMap type

DagShortestPathWizard<DefDistMapBase<T> > distMap const T &  t  )  [inline]
 

Named parameter function for setting DistMap type

DagShortestPathWizard<DefOperationTraitsBase<T> > distMap  )  [inline]
 

Named parameter function for setting OperationTraits type

DagShortestPathWizard<_Traits>& source Node  source  )  [inline]
 

Sets the source node, from which the DagShortestPath algorithm runs.

Parameters:
source is the source node.


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