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

DfsWizard Class Template Reference

#include <lemon/dfs.h>

List of all members.


Detailed Description

template<class TR>
class lemon::DfsWizard< TR >

This class is created to make it easier to use the Dfs algorithm. It uses the functions and features of the plain Dfs, 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 Dfs the new class with the modified type comes from the original class by using the :: operator. In the case of DfsWizard 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 Dfs object, and calls the Dfs::run method of it.


Public Member Functions

 DfsWizard ()
 Constructor.
 DfsWizard (const Graph &g, Node s=INVALID)
 Constructor that requires parameters.
 DfsWizard (const TR &b)
 Copy constructor.
void run ()
 Runs Dfs algorithm from a given node.
void run (Node s)
 Runs Dfs algorithm from the given node.
template<class T>
DfsWizard< DefPredMapBase<
T > > 
predMap (const T &t)
 Named parameter function for setting PredMap type
template<class T>
DfsWizard< DefReachedMapBase<
T > > 
reachedMap (const T &t)
 Named parameter function for setting ReachedMap
template<class T>
DfsWizard< DefProcessedMapBase<
T > > 
processedMap (const T &t)
 Named parameter function for setting ProcessedMap
template<class T>
DfsWizard< DefDistMapBase<
T > > 
distMap (const T &t)
 Named parameter function for setting DistMap type
DfsWizard< TR > & source (Node s)
 Sets the source node, from which the Dfs algorithm runs.


Constructor & Destructor Documentation

DfsWizard const Graph &  g,
Node  s = INVALID
[inline]
 

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


Member Function Documentation

void run  )  [inline]
 

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

void run Node  s  )  [inline]
 

Runs Dfs algorithm from the given node.

Parameters:
s is the given source.

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

Named parameter function for setting PredMap type

DfsWizard<DefReachedMapBase<T> > reachedMap const T &  t  )  [inline]
 

Named parameter function for setting ReachedMap

DfsWizard<DefProcessedMapBase<T> > processedMap const T &  t  )  [inline]
 

Named parameter function for setting ProcessedMap

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

Named parameter function for setting DistMap type

DfsWizard<TR>& source Node  s  )  [inline]
 

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

Parameters:
s is the source node.


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