diff -r 640ca1bd850f -r 5331168bbb18 src/lemon/dfs.h --- a/src/lemon/dfs.h Wed Mar 16 07:52:16 2005 +0000 +++ b/src/lemon/dfs.h Wed Mar 16 07:56:25 2005 +0000 @@ -19,35 +19,150 @@ ///\ingroup flowalgs ///\file -///\brief %DFS algorithm. -/// -///\todo Revise Manual. +///\brief Dfs algorithm. +#include #include #include +#include +#include namespace lemon { -/// \addtogroup flowalgs -/// @{ + + ///Default traits class of Dfs class. + + ///Default traits class of Dfs class. + ///\param GR Graph type. + template + struct DfsDefaultTraits + { + ///The graph type the algorithm runs on. + typedef GR Graph; + ///\brief The type of the map that stores the last + ///edges of the %DFS paths. + /// + ///The type of the map that stores the last + ///edges of the %DFS paths. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. + /// + typedef typename Graph::template NodeMap PredMap; + ///Instantiates a PredMap. + + ///This function instantiates a \ref PredMap. + ///\param G is the graph, to which we would like to define the PredMap. + ///\todo The graph alone may be insufficient to initialize + static PredMap *createPredMap(const GR &G) + { + return new PredMap(G); + } +// ///\brief The type of the map that stores the last but one +// ///nodes of the %DFS paths. +// /// +// ///The type of the map that stores the last but one +// ///nodes of the %DFS paths. +// ///It must meet the \ref concept::WriteMap "WriteMap" concept. +// /// +// typedef NullMap PredNodeMap; +// ///Instantiates a PredNodeMap. + +// ///This function instantiates a \ref PredNodeMap. +// ///\param G is the graph, to which +// ///we would like to define the \ref PredNodeMap +// static PredNodeMap *createPredNodeMap(const GR &G) +// { +// return new PredNodeMap(); +// } + + ///The type of the map that indicates which nodes are processed. + + ///The type of the map that indicates which nodes are processed. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. + ///\todo named parameter to set this type, function to read and write. + typedef NullMap ProcessedMap; + ///Instantiates a ProcessedMap. + + ///This function instantiates a \ref ProcessedMap. + ///\param G is the graph, to which + ///we would like to define the \ref ProcessedMap + static ProcessedMap *createProcessedMap(const GR &G) + { + return new ProcessedMap(); + } + ///The type of the map that indicates which nodes are reached. + + ///The type of the map that indicates which nodes are reached. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. + ///\todo named parameter to set this type, function to read and write. + typedef typename Graph::template NodeMap ReachedMap; + ///Instantiates a ReachedMap. + + ///This function instantiates a \ref ReachedMap. + ///\param G is the graph, to which + ///we would like to define the \ref ReachedMap. + static ReachedMap *createReachedMap(const GR &G) + { + return new ReachedMap(G); + } + ///The type of the map that stores the dists of the nodes. + + ///The type of the map that stores the dists of the nodes. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. + /// + typedef typename Graph::template NodeMap DistMap; + ///Instantiates a DistMap. + + ///This function instantiates a \ref DistMap. + ///\param G is the graph, to which we would like to define the \ref DistMap + static DistMap *createDistMap(const GR &G) + { + return new DistMap(G); + } + }; + ///%DFS algorithm class. - - ///This class provides an efficient implementation of %DFS algorithm. + + ///\ingroup flowalgs + ///This class provides an efficient implementation of the %DFS algorithm. /// - ///\param GR The graph type the algorithm runs on. + ///\param GR The graph type the algorithm runs on. The default value is + ///\ref ListGraph. The value of GR is not used directly by Dfs, it + ///is only passed to \ref DfsDefaultTraits. + ///\param TR Traits class to set various data types used by the algorithm. + ///The default traits class is + ///\ref DfsDefaultTraits "DfsDefaultTraits". + ///See \ref DfsDefaultTraits for the documentation of + ///a Dfs traits class. /// - ///\author Alpar Juttner + ///\author Jacint Szabo and Alpar Juttner + ///\todo A compare object would be nice. #ifdef DOXYGEN - template + template #else - template + template > #endif - class Dfs{ + class Dfs { public: + /** + * \brief \ref Exception for uninitialized parameters. + * + * This error represents problems in the initialization + * of the parameters of the algorithms. + */ + class UninitializedParameter : public lemon::UninitializedParameter { + public: + virtual const char* exceptionName() const { + return "lemon::Dfs::UninitializedParameter"; + } + }; + + typedef TR Traits; ///The type of the underlying graph. - typedef GR Graph; + typedef typename TR::Graph Graph; ///\e typedef typename Graph::Node Node; ///\e @@ -58,69 +173,211 @@ typedef typename Graph::OutEdgeIt OutEdgeIt; ///\brief The type of the map that stores the last - ///edges of the paths on the %DFS tree. - typedef typename Graph::template NodeMap PredMap; - ///\brief The type of the map that stores the last but one - ///nodes of the paths on the %DFS tree. - typedef typename Graph::template NodeMap PredNodeMap; - ///The type of the map that stores the dists of the nodes on the %DFS tree. - typedef typename Graph::template NodeMap DistMap; - + ///edges of the %DFS paths. + typedef typename TR::PredMap PredMap; +// ///\brief The type of the map that stores the last but one +// ///nodes of the %DFS paths. +// typedef typename TR::PredNodeMap PredNodeMap; + ///The type of the map indicating which nodes are reached. + typedef typename TR::ReachedMap ReachedMap; + ///The type of the map indicating which nodes are processed. + typedef typename TR::ProcessedMap ProcessedMap; + ///The type of the map that stores the dists of the nodes. + typedef typename TR::DistMap DistMap; private: /// Pointer to the underlying graph. const Graph *G; ///Pointer to the map of predecessors edges. - PredMap *predecessor; - ///Indicates if \ref predecessor is locally allocated (\c true) or not. - bool local_predecessor; - ///Pointer to the map of predecessors nodes. - PredNodeMap *pred_node; - ///Indicates if \ref pred_node is locally allocated (\c true) or not. - bool local_pred_node; + PredMap *_pred; + ///Indicates if \ref _pred is locally allocated (\c true) or not. + bool local_pred; +// ///Pointer to the map of predecessors nodes. +// PredNodeMap *_predNode; +// ///Indicates if \ref _predNode is locally allocated (\c true) or not. +// bool local_predNode; ///Pointer to the map of distances. - DistMap *distance; - ///Indicates if \ref distance is locally allocated (\c true) or not. - bool local_distance; + DistMap *_dist; + ///Indicates if \ref _dist is locally allocated (\c true) or not. + bool local_dist; + ///Pointer to the map of reached status of the nodes. + ReachedMap *_reached; + ///Indicates if \ref _reached is locally allocated (\c true) or not. + bool local_reached; + ///Pointer to the map of processed status of the nodes. + ProcessedMap *_processed; + ///Indicates if \ref _processed is locally allocated (\c true) or not. + bool local_processed; - ///The source node of the last execution. - Node source; + std::vector _stack; + int _stack_head; +// ///The source node of the last execution. +// Node source; - - ///Initializes the maps. - void init_maps() + ///Creates the maps if necessary. + + ///\todo Error if \c G are \c NULL. + ///\todo Better memory allocation (instead of new). + void create_maps() { - if(!predecessor) { - local_predecessor = true; - predecessor = new PredMap(*G); + if(!_pred) { + local_pred = true; + _pred = Traits::createPredMap(*G); } - if(!pred_node) { - local_pred_node = true; - pred_node = new PredNodeMap(*G); +// if(!_predNode) { +// local_predNode = true; +// _predNode = Traits::createPredNodeMap(*G); +// } + if(!_dist) { + local_dist = true; + _dist = Traits::createDistMap(*G); } - if(!distance) { - local_distance = true; - distance = new DistMap(*G); + if(!_reached) { + local_reached = true; + _reached = Traits::createReachedMap(*G); + } + if(!_processed) { + local_processed = true; + _processed = Traits::createProcessedMap(*G); } } - public : + public : + + ///\name Named template parameters + + ///@{ + + template + struct DefPredMapTraits : public Traits { + typedef T PredMap; + static PredMap *createPredMap(const Graph &G) + { + throw UninitializedParameter(); + } + }; + ///\ref named-templ-param "Named parameter" for setting PredMap type + + ///\ref named-templ-param "Named parameter" for setting PredMap type + /// + template + class DefPredMap : public Dfs< Graph, + DefPredMapTraits > { }; + +// template +// struct DefPredNodeMapTraits : public Traits { +// typedef T PredNodeMap; +// static PredNodeMap *createPredNodeMap(const Graph &G) +// { +// throw UninitializedParameter(); +// } +// }; +// ///\ref named-templ-param "Named parameter" for setting PredNodeMap type + +// ///\ref named-templ-param "Named parameter" for setting PredNodeMap type +// /// +// template +// class DefPredNodeMap : public Dfs< Graph, +// LengthMap, +// DefPredNodeMapTraits > { }; + + template + struct DefDistMapTraits : public Traits { + typedef T DistMap; + static DistMap *createDistMap(const Graph &G) + { + throw UninitializedParameter(); + } + }; + ///\ref named-templ-param "Named parameter" for setting DistMap type + + ///\ref named-templ-param "Named parameter" for setting DistMap type + /// + template + class DefDistMap : public Dfs< Graph, + DefDistMapTraits > { }; + + template + struct DefReachedMapTraits : public Traits { + typedef T ReachedMap; + static ReachedMap *createReachedMap(const Graph &G) + { + throw UninitializedParameter(); + } + }; + ///\ref named-templ-param "Named parameter" for setting ReachedMap type + + ///\ref named-templ-param "Named parameter" for setting ReachedMap type + /// + template + class DefReachedMap : public Dfs< Graph, + DefReachedMapTraits > { }; + + struct DefGraphReachedMapTraits : public Traits { + typedef typename Graph::template NodeMap ReachedMap; + static ReachedMap *createReachedMap(const Graph &G) + { + return new ReachedMap(G); + } + }; + template + struct DefProcessedMapTraits : public Traits { + typedef T ProcessedMap; + static ProcessedMap *createProcessedMap(const Graph &G) + { + throw UninitializedParameter(); + } + }; + ///\ref named-templ-param "Named parameter" for setting ProcessedMap type + + ///\ref named-templ-param "Named parameter" for setting ProcessedMap type + /// + template + class DefProcessedMap : public Dfs< Graph, + DefProcessedMapTraits > { }; + + struct DefGraphProcessedMapTraits : public Traits { + typedef typename Graph::template NodeMap ProcessedMap; + static ProcessedMap *createProcessedMap(const Graph &G) + { + return new ProcessedMap(G); + } + }; + ///\brief \ref named-templ-param "Named parameter" + ///for setting the ProcessedMap type to be Graph::NodeMap. + /// + ///\ref named-templ-param "Named parameter" + ///for setting the ProcessedMap type to be Graph::NodeMap. + ///If you don't set it explicitely, it will be automatically allocated. + template + class DefProcessedMapToBeDefaultMap : + public Dfs< Graph, + DefGraphProcessedMapTraits> { }; + + ///@} + + public: + ///Constructor. ///\param _G the graph the algorithm will run on. /// Dfs(const Graph& _G) : G(&_G), - predecessor(NULL), local_predecessor(false), - pred_node(NULL), local_pred_node(false), - distance(NULL), local_distance(false) + _pred(NULL), local_pred(false), +// _predNode(NULL), local_predNode(false), + _dist(NULL), local_dist(false), + _reached(NULL), local_reached(false), + _processed(NULL), local_processed(false) { } ///Destructor. ~Dfs() { - if(local_predecessor) delete predecessor; - if(local_pred_node) delete pred_node; - if(local_distance) delete distance; + if(local_pred) delete _pred; +// if(local_predNode) delete _predNode; + if(local_dist) delete _dist; + if(local_reached) delete _reached; + if(local_processed) delete _processed; } ///Sets the map storing the predecessor edges. @@ -130,32 +387,32 @@ ///it will allocate one. The destuctor deallocates this ///automatically allocated map, of course. ///\return (*this) - Dfs &setPredMap(PredMap &m) + Dfs &predMap(PredMap &m) { - if(local_predecessor) { - delete predecessor; - local_predecessor=false; + if(local_pred) { + delete _pred; + local_pred=false; } - predecessor = &m; + _pred = &m; return *this; } - ///Sets the map storing the predecessor nodes. +// ///Sets the map storing the predecessor nodes. - ///Sets the map storing the predecessor nodes. - ///If you don't use this function before calling \ref run(), - ///it will allocate one. The destuctor deallocates this - ///automatically allocated map, of course. - ///\return (*this) - Dfs &setPredNodeMap(PredNodeMap &m) - { - if(local_pred_node) { - delete pred_node; - local_pred_node=false; - } - pred_node = &m; - return *this; - } +// ///Sets the map storing the predecessor nodes. +// ///If you don't use this function before calling \ref run(), +// ///it will allocate one. The destuctor deallocates this +// ///automatically allocated map, of course. +// ///\return (*this) +// Dfs &predNodeMap(PredNodeMap &m) +// { +// if(local_predNode) { +// delete _predNode; +// local_predNode=false; +// } +// _predNode = &m; +// return *this; +// } ///Sets the map storing the distances calculated by the algorithm. @@ -164,127 +421,655 @@ ///it will allocate one. The destuctor deallocates this ///automatically allocated map, of course. ///\return (*this) - Dfs &setDistMap(DistMap &m) + Dfs &distMap(DistMap &m) { - if(local_distance) { - delete distance; - local_distance=false; + if(local_dist) { + delete _dist; + local_dist=false; } - distance = &m; + _dist = &m; return *this; } - - ///Runs %DFS algorithm from node \c s. - ///This method runs the %DFS algorithm from a root node \c s - ///in order to - ///compute - ///- a %DFS tree and - ///- the distance of each node from the root on this tree. - - void run(Node s) { - - init_maps(); - - source = s; - + public: + ///\name Execution control + ///The simplest way to execute the algorithm is to use + ///one of the member functions called \c run(...). + ///\n + ///If you need more control on the execution, + ///first you must call \ref init(), then you can add several source nodes + ///with \ref addSource(). + ///Finally \ref start() will perform the actual path + ///computation. + + ///@{ + + ///Initializes the internal data structures. + + ///Initializes the internal data structures. + /// + void init() + { + create_maps(); + _stack.resize(countNodes(*G)); + _stack_head=-1; for ( NodeIt u(*G) ; u!=INVALID ; ++u ) { - predecessor->set(u,INVALID); - pred_node->set(u,INVALID); + _pred->set(u,INVALID); + // _predNode->set(u,INVALID); + _reached->set(u,false); + _processed->set(u,false); } - - int N = countNodes(*G); - std::vector Q(N); - - int Qh=0; - - Q[Qh] = OutEdgeIt(*G, s); - distance->set(s, 0); - - Node n=s; - Node m; - OutEdgeIt e; - do { - if((e=Q[Qh])!=INVALID) - if((m=G->target(e))!=s && (*predecessor)[m=G->target(e)]==INVALID) { - predecessor->set(m,e); - pred_node->set(m,n); - Q[++Qh] = OutEdgeIt(*G, m); - distance->set(m,Qh); - n=m; - } - else ++Q[Qh]; - else if(--Qh>=0) n=G->source(Q[Qh]); - } while(Qh>=0); } - ///The distance of a node from the root on the %DFS tree. + ///Adds a new source node. - ///Returns the distance of a node from the root on the %DFS tree. + ///Adds a new source node to the set of nodes to be processed. + /// + ///\bug dist's are wrong (or at least strange) in case of multiple sources. + void addSource(Node s) + { + if(!(*_reached)[s]) + { + _reached->set(s,true); + _pred->set(s,INVALID); + // _predNode->set(u,INVALID); + _stack[++_stack_head]=OutEdgeIt(*G,s); + _dist->set(s,_stack_head); + } + } + + ///Processes the next node. + + ///Processes the next node. + /// + ///\warning The stack must not be empty! + void processNextEdge() + { + Node m; + Edge e=_stack[_stack_head]; + if(!(*_reached)[m=G->target(e)]) { + _pred->set(m,e); + _reached->set(m,true); + // _pred_node->set(m,G->source(e)); + _stack[++_stack_head] = OutEdgeIt(*G, m); + _dist->set(m,_stack_head); + } + else { + Node n; + while(_stack_head>=0 && + (n=G->source(_stack[_stack_head]), + ++_stack[_stack_head]==INVALID)) + { + _processed->set(n,true); + --_stack_head; + } + } + } + + ///\brief Returns \c false if there are nodes + ///to be processed in the queue + /// + ///Returns \c false if there are nodes + ///to be processed in the queue + bool emptyQueue() { return _stack_head<0; } + ///Returns the number of the nodes to be processed. + + ///Returns the number of the nodes to be processed in the queue. + /// + int queueSize() { return _stack_head+1; } + + ///Executes the algorithm. + + ///Executes the algorithm. + /// + ///\pre init() must be called and at least one node should be added + ///with addSource() before using this function. + /// + ///This method runs the %DFS algorithm from the root node(s) + ///in order to + ///compute the + ///%DFS path to each node. The algorithm computes + ///- The %DFS tree. + ///- The distance of each node from the root(s). + /// + void start() + { + while ( !emptyQueue() ) processNextEdge(); + } + + ///Executes the algorithm until \c dest is reached. + + ///Executes the algorithm until \c dest is reached. + /// + ///\pre init() must be called and at least one node should be added + ///with addSource() before using this function. + /// + ///This method runs the %DFS algorithm from the root node(s) + ///in order to + ///compute the + ///%DFS path to \c dest. The algorithm computes + ///- The %DFS path to \c dest. + ///- The distance of \c dest from the root(s). + /// + void start(Node dest) + { + while ( !emptyQueue() && _queue[_queue_tail]!=dest ) processNextEdge(); + } + + ///Executes the algorithm until a condition is met. + + ///Executes the algorithm until a condition is met. + /// + ///\pre init() must be called and at least one node should be added + ///with addSource() before using this function. + /// + ///\param nm must be a bool (or convertible) node map. The algorithm + ///will stop when it reaches a node \c v with nm[v]==true. + template + void start(const NM &nm) + { + while ( !emptyQueue() && !nm[_queue[_queue_tail]] ) processNextEdge(); + } + + ///Runs %DFS algorithm from node \c s. + + ///This method runs the %DFS algorithm from a root node \c s + ///in order to + ///compute the + ///%DFS path to each node. The algorithm computes + ///- The %DFS tree. + ///- The distance of each node from the root. + /// + ///\note d.run(s) is just a shortcut of the following code. + ///\code + /// d.init(); + /// d.addSource(s); + /// d.start(); + ///\endcode + void run(Node s) { + init(); + addSource(s); + start(); + } + + ///Finds the %DFS path between \c s and \c t. + + ///Finds the %DFS path between \c s and \c t. + /// + ///\return The length of the %DFS s---t path if there exists one, + ///0 otherwise. + ///\note Apart from the return value, d.run(s) is + ///just a shortcut of the following code. + ///\code + /// d.init(); + /// d.addSource(s); + /// d.start(t); + ///\endcode + int run(Node s,Node t) { + init(); + addSource(s); + start(t); + return reached(t)?_curr_dist-1+(_queue_tail==_queue_next_dist):0; + } + + ///@} + + ///\name Query Functions + ///The result of the %DFS algorithm can be obtained using these + ///functions.\n + ///Before the use of these functions, + ///either run() or start() must be called. + + ///@{ + + ///The distance of a node from the root(s). + + ///Returns the distance of a node from the root(s). ///\pre \ref run() must be called before using this function. - ///\warning If node \c v in unreachable from the root the return value + ///\warning If node \c v in unreachable from the root(s) the return value ///of this funcion is undefined. - int dist(Node v) const { return (*distance)[v]; } + int dist(Node v) const { return (*_dist)[v]; } - ///Returns the 'previous edge' of the %DFS path tree. + ///Returns the 'previous edge' of the %DFS tree. - ///For a node \c v it returns the last edge of the path on the %DFS tree - ///from the root to \c + ///For a node \c v it returns the 'previous edge' + ///of the %DFS path, + ///i.e. it returns the last edge of a %DFS path from the root(s) to \c ///v. It is \ref INVALID - ///if \c v is unreachable from the root or if \c v=s. The + ///if \c v is unreachable from the root(s) or \c v is a root. The ///%DFS tree used here is equal to the %DFS tree used in - ///\ref predNode(Node v). \pre \ref run() must be called before using + ///\ref predNode(Node v). + ///\pre Either \ref run() or \ref start() must be called before using ///this function. - Edge pred(Node v) const { return (*predecessor)[v]; } + ///\todo predEdge could be a better name. + Edge pred(Node v) const { return (*_pred)[v];} ///Returns the 'previous node' of the %DFS tree. - ///For a node \c v it returns the 'previous node' on the %DFS tree, - ///i.e. it returns the last but one node of the path from the - ///root to \c /v on the %DFS tree. - ///It is INVALID if \c v is unreachable from the root or if - ///\c v=s. - ///\pre \ref run() must be called before + ///For a node \c v it returns the 'previous node' + ///of the %DFS tree, + ///i.e. it returns the last but one node from a %DFS path from the + ///root(a) to \c /v. + ///It is INVALID if \c v is unreachable from the root(s) or + ///if \c v itself a root. + ///The %DFS tree used here is equal to the %DFS + ///tree used in \ref pred(Node v). + ///\pre Either \ref run() or \ref start() must be called before ///using this function. - Node predNode(Node v) const { return (*pred_node)[v]; } + Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID: + G->source((*_pred)[v]); } - ///Returns a reference to the NodeMap of distances on the %DFS tree. - - ///Returns a reference to the NodeMap of distances on the %DFS tree. - ///\pre \ref run() must + ///Returns a reference to the NodeMap of distances. + + ///Returns a reference to the NodeMap of distances. + ///\pre Either \ref run() or \ref init() must ///be called before using this function. - const DistMap &distMap() const { return *distance;} + const DistMap &distMap() const { return *_dist;} - ///Returns a reference to the %DFS tree map. + ///Returns a reference to the %DFS edge-tree map. ///Returns a reference to the NodeMap of the edges of the ///%DFS tree. - ///\pre \ref run() must be called before using this function. - const PredMap &predMap() const { return *predecessor;} + ///\pre Either \ref run() or \ref init() + ///must be called before using this function. + const PredMap &predMap() const { return *_pred;} - ///Returns a reference to the map of last but one nodes of the %DFS tree. +// ///Returns a reference to the map of nodes of %DFS paths. - ///Returns a reference to the NodeMap of the last but one nodes of the paths - ///on the - ///%DFS tree. - ///\pre \ref run() must be called before using this function. - const PredNodeMap &predNodeMap() const { return *pred_node;} +// ///Returns a reference to the NodeMap of the last but one nodes of the +// ///%DFS tree. +// ///\pre \ref run() must be called before using this function. +// const PredNodeMap &predNodeMap() const { return *_predNode;} ///Checks if a node is reachable from the root. ///Returns \c true if \c v is reachable from the root. - ///\note The root node is reported to be reached! + ///\warning The source nodes are inditated as unreached. + ///\pre Either \ref run() or \ref start() + ///must be called before using this function. /// - ///\pre \ref run() must be called before using this function. + bool reached(Node v) { return (*_reached)[v]; } + + ///@} + }; + + ///Default traits class of Dfs function. + + ///Default traits class of Dfs function. + ///\param GR Graph type. + template + struct DfsWizardDefaultTraits + { + ///The graph type the algorithm runs on. + typedef GR Graph; + ///\brief The type of the map that stores the last + ///edges of the %DFS paths. + /// + ///The type of the map that stores the last + ///edges of the %DFS paths. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. /// - bool reached(Node v) { return v==source || (*predecessor)[v]!=INVALID; } + typedef NullMap PredMap; + ///Instantiates a PredMap. + + ///This function instantiates a \ref PredMap. + ///\param G is the graph, to which we would like to define the PredMap. + ///\todo The graph alone may be insufficient to initialize + static PredMap *createPredMap(const GR &G) + { + return new PredMap(); + } +// ///\brief The type of the map that stores the last but one +// ///nodes of the %DFS paths. +// /// +// ///The type of the map that stores the last but one +// ///nodes of the %DFS paths. +// ///It must meet the \ref concept::WriteMap "WriteMap" concept. +// /// +// typedef NullMap PredNodeMap; +// ///Instantiates a PredNodeMap. + +// ///This function instantiates a \ref PredNodeMap. +// ///\param G is the graph, to which +// ///we would like to define the \ref PredNodeMap +// static PredNodeMap *createPredNodeMap(const GR &G) +// { +// return new PredNodeMap(); +// } + + ///The type of the map that indicates which nodes are processed. + + ///The type of the map that indicates which nodes are processed. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. + ///\todo named parameter to set this type, function to read and write. + typedef NullMap ProcessedMap; + ///Instantiates a ProcessedMap. + + ///This function instantiates a \ref ProcessedMap. + ///\param G is the graph, to which + ///we would like to define the \ref ProcessedMap + static ProcessedMap *createProcessedMap(const GR &G) + { + return new ProcessedMap(); + } + ///The type of the map that indicates which nodes are reached. + + ///The type of the map that indicates which nodes are reached. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. + ///\todo named parameter to set this type, function to read and write. + typedef typename Graph::template NodeMap ReachedMap; + ///Instantiates a ReachedMap. + + ///This function instantiates a \ref ReachedMap. + ///\param G is the graph, to which + ///we would like to define the \ref ReachedMap. + static ReachedMap *createReachedMap(const GR &G) + { + return new ReachedMap(G); + } + ///The type of the map that stores the dists of the nodes. + + ///The type of the map that stores the dists of the nodes. + ///It must meet the \ref concept::WriteMap "WriteMap" concept. + /// + typedef NullMap DistMap; + ///Instantiates a DistMap. + + ///This function instantiates a \ref DistMap. + ///\param G is the graph, to which we would like to define the \ref DistMap + static DistMap *createDistMap(const GR &G) + { + return new DistMap(); + } + }; + + /// Default traits used by \ref DfsWizard + + /// To make it easier to use Dfs algorithm + ///we have created a wizard class. + /// This \ref DfsWizard class needs default traits, + ///as well as the \ref Dfs class. + /// The \ref DfsWizardBase is a class to be the default traits of the + /// \ref DfsWizard class. + template + class DfsWizardBase : public DfsWizardDefaultTraits + { + + typedef DfsWizardDefaultTraits Base; + protected: + /// Type of the nodes in the graph. + typedef typename Base::Graph::Node Node; + + /// Pointer to the underlying graph. + void *_g; + ///Pointer to the map of reached nodes. + void *_reached; + ///Pointer to the map of processed nodes. + void *_processed; + ///Pointer to the map of predecessors edges. + void *_pred; +// ///Pointer to the map of predecessors nodes. +// void *_predNode; + ///Pointer to the map of distances. + void *_dist; + ///Pointer to the source node. + Node _source; + + public: + /// Constructor. + + /// This constructor does not require parameters, therefore it initiates + /// all of the attributes to default values (0, INVALID). + DfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0), +// _predNode(0), + _dist(0), _source(INVALID) {} + + /// Constructor. + + /// This constructor requires some parameters, + /// listed in the parameters list. + /// Others are initiated to 0. + /// \param g is the initial value of \ref _g + /// \param s is the initial value of \ref _source + DfsWizardBase(const GR &g, Node s=INVALID) : + _g((void *)&g), _reached(0), _processed(0), _pred(0), +// _predNode(0), + _dist(0), _source(s) {} + + }; + + /// A class to make the usage of Dfs algorithm easier + + /// This class is created to make it easier to use Dfs algorithm. + /// It uses the functions and features of the plain \ref 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 \ref Dfs + /// the new class with the modified type comes from + /// the original class by using the :: + /// operator. In the case of \ref DfsWizard only + /// a function have to be called and it will + /// return the needed class. + /// + /// It does not have own \ref run method. When its \ref run method is called + /// it initiates a plain \ref Dfs class, and calls the \ref Dfs::run + /// method of it. + template + class DfsWizard : public TR + { + typedef TR Base; + + ///The type of the underlying graph. + typedef typename TR::Graph Graph; + //\e + typedef typename Graph::Node Node; + //\e + typedef typename Graph::NodeIt NodeIt; + //\e + typedef typename Graph::Edge Edge; + //\e + typedef typename Graph::OutEdgeIt OutEdgeIt; + + ///\brief The type of the map that stores + ///the reached nodes + typedef typename TR::ReachedMap ReachedMap; + ///\brief The type of the map that stores + ///the processed nodes + typedef typename TR::ProcessedMap ProcessedMap; + ///\brief The type of the map that stores the last + ///edges of the %DFS paths. + typedef typename TR::PredMap PredMap; +// ///\brief The type of the map that stores the last but one +// ///nodes of the %DFS paths. +// typedef typename TR::PredNodeMap PredNodeMap; + ///The type of the map that stores the dists of the nodes. + typedef typename TR::DistMap DistMap; + +public: + /// Constructor. + DfsWizard() : TR() {} + + /// Constructor that requires parameters. + + /// Constructor that requires parameters. + /// These parameters will be the default values for the traits class. + DfsWizard(const Graph &g, Node s=INVALID) : + TR(g,s) {} + + ///Copy constructor + DfsWizard(const TR &b) : TR(b) {} + + ~DfsWizard() {} + + ///Runs Dfs algorithm from a given node. + + ///Runs Dfs algorithm from a given node. + ///The node can be given by the \ref source function. + void run() + { + if(Base::_source==INVALID) throw UninitializedParameter(); + Dfs alg(*(Graph*)Base::_g); + if(Base::_reached) alg.reachedMap(*(ReachedMap*)Base::_reached); + if(Base::_processed) alg.processedMap(*(ProcessedMap*)Base::_processed); + if(Base::_pred) alg.predMap(*(PredMap*)Base::_pred); +// if(Base::_predNode) alg.predNodeMap(*(PredNodeMap*)Base::_predNode); + if(Base::_dist) alg.distMap(*(DistMap*)Base::_dist); + alg.run(Base::_source); + } + + ///Runs Dfs algorithm from the given node. + + ///Runs Dfs algorithm from the given node. + ///\param s is the given source. + void run(Node s) + { + Base::_source=s; + run(); + } + + template + struct DefPredMapBase : public Base { + typedef T PredMap; + static PredMap *createPredMap(const Graph &G) { return 0; }; + DefPredMapBase(const Base &b) : Base(b) {} + }; + + ///\brief \ref named-templ-param "Named parameter" + ///function for setting PredMap type + /// + /// \ref named-templ-param "Named parameter" + ///function for setting PredMap type + /// + template + DfsWizard > predMap(const T &t) + { + Base::_pred=(void *)&t; + return DfsWizard >(*this); + } + + + template + struct DefReachedMapBase : public Base { + typedef T ReachedMap; + static ReachedMap *createReachedMap(const Graph &G) { return 0; }; + DefReachedMapBase(const Base &b) : Base(b) {} + }; + + ///\brief \ref named-templ-param "Named parameter" + ///function for setting ReachedMap + /// + /// \ref named-templ-param "Named parameter" + ///function for setting ReachedMap + /// + template + DfsWizard > reachedMap(const T &t) + { + Base::_pred=(void *)&t; + return DfsWizard >(*this); + } + + + template + struct DefProcessedMapBase : public Base { + typedef T ProcessedMap; + static ProcessedMap *createProcessedMap(const Graph &G) { return 0; }; + DefProcessedMapBase(const Base &b) : Base(b) {} + }; + + ///\brief \ref named-templ-param "Named parameter" + ///function for setting ProcessedMap + /// + /// \ref named-templ-param "Named parameter" + ///function for setting ProcessedMap + /// + template + DfsWizard > processedMap(const T &t) + { + Base::_pred=(void *)&t; + return DfsWizard >(*this); + } + + +// template +// struct DefPredNodeMapBase : public Base { +// typedef T PredNodeMap; +// static PredNodeMap *createPredNodeMap(const Graph &G) { return 0; }; +// DefPredNodeMapBase(const Base &b) : Base(b) {} +// }; + +// ///\brief \ref named-templ-param "Named parameter" +// ///function for setting PredNodeMap type +// /// +// /// \ref named-templ-param "Named parameter" +// ///function for setting PredNodeMap type +// /// +// template +// DfsWizard > predNodeMap(const T &t) +// { +// Base::_predNode=(void *)&t; +// return DfsWizard >(*this); +// } + + template + struct DefDistMapBase : public Base { + typedef T DistMap; + static DistMap *createDistMap(const Graph &G) { return 0; }; + DefDistMapBase(const Base &b) : Base(b) {} + }; + + ///\brief \ref named-templ-param "Named parameter" + ///function for setting DistMap type + /// + /// \ref named-templ-param "Named parameter" + ///function for setting DistMap type + /// + template + DfsWizard > distMap(const T &t) + { + Base::_dist=(void *)&t; + return DfsWizard >(*this); + } + + /// Sets the source node, from which the Dfs algorithm runs. + + /// Sets the source node, from which the Dfs algorithm runs. + /// \param s is the source node. + DfsWizard &source(Node s) + { + Base::_source=s; + return *this; + } }; -/// @} - + ///Function type interface for Dfs algorithm. + + /// \ingroup flowalgs + ///Function type interface for Dfs algorithm. + /// + ///This function also has several + ///\ref named-templ-func-param "named parameters", + ///they are declared as the members of class \ref DfsWizard. + ///The following + ///example shows how to use these parameters. + ///\code + /// dfs(g,source).predMap(preds).run(); + ///\endcode + ///\warning Don't forget to put the \ref DfsWizard::run() "run()" + ///to the end of the parameter list. + ///\sa DfsWizard + ///\sa Dfs + template + DfsWizard > + dfs(const GR &g,typename GR::Node s=INVALID) + { + return DfsWizard >(g,s); + } + } //END OF NAMESPACE LEMON #endif -