COIN-OR::LEMON - Graph Library

source: lemon-0.x/src/lemon/dfs.h @ 1220:20b26ee5812b

Last change on this file since 1220:20b26ee5812b was 1220:20b26ee5812b, checked in by Alpar Juttner, 16 years ago
  • Add compilation tests for the function type interface of BFS/DFS/Dijkstra
  • Fix the bugs covered up by these tests
File size: 34.0 KB
Line 
1/* -*- C++ -*-
2 * src/lemon/dfs.h - Part of LEMON, a generic C++ optimization library
3 *
4 * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
5 * (Egervary Combinatorial Optimization Research Group, EGRES).
6 *
7 * Permission to use, modify and distribute this software is granted
8 * provided that this copyright notice appears in all copies. For
9 * precise terms see the accompanying LICENSE file.
10 *
11 * This software is provided "AS IS" with no warranty of any kind,
12 * express or implied, and with no claim as to its suitability for any
13 * purpose.
14 *
15 */
16
17#ifndef LEMON_DFS_H
18#define LEMON_DFS_H
19
20///\ingroup flowalgs
21///\file
22///\brief Dfs algorithm.
23
24#include <lemon/list_graph.h>
25#include <lemon/graph_utils.h>
26#include <lemon/invalid.h>
27#include <lemon/error.h>
28#include <lemon/maps.h>
29
30namespace lemon {
31
32
33 
34  ///Default traits class of Dfs class.
35
36  ///Default traits class of Dfs class.
37  ///\param GR Graph type.
38  template<class GR>
39  struct DfsDefaultTraits
40  {
41    ///The graph type the algorithm runs on.
42    typedef GR Graph;
43    ///\brief The type of the map that stores the last
44    ///edges of the %DFS paths.
45    ///
46    ///The type of the map that stores the last
47    ///edges of the %DFS paths.
48    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
49    ///
50    typedef typename Graph::template NodeMap<typename GR::Edge> PredMap;
51    ///Instantiates a PredMap.
52 
53    ///This function instantiates a \ref PredMap.
54    ///\param G is the graph, to which we would like to define the PredMap.
55    ///\todo The graph alone may be insufficient to initialize
56    static PredMap *createPredMap(const GR &G)
57    {
58      return new PredMap(G);
59    }
60//     ///\brief The type of the map that stores the last but one
61//     ///nodes of the %DFS paths.
62//     ///
63//     ///The type of the map that stores the last but one
64//     ///nodes of the %DFS paths.
65//     ///It must meet the \ref concept::WriteMap "WriteMap" concept.
66//     ///
67//     typedef NullMap<typename Graph::Node,typename Graph::Node> PredNodeMap;
68//     ///Instantiates a PredNodeMap.
69   
70//     ///This function instantiates a \ref PredNodeMap.
71//     ///\param G is the graph, to which
72//     ///we would like to define the \ref PredNodeMap
73//     static PredNodeMap *createPredNodeMap(const GR &G)
74//     {
75//       return new PredNodeMap();
76//     }
77
78    ///The type of the map that indicates which nodes are processed.
79 
80    ///The type of the map that indicates which nodes are processed.
81    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
82    ///\todo named parameter to set this type, function to read and write.
83    typedef NullMap<typename Graph::Node,bool> ProcessedMap;
84    ///Instantiates a ProcessedMap.
85 
86    ///This function instantiates a \ref ProcessedMap.
87    ///\param G is the graph, to which
88    ///we would like to define the \ref ProcessedMap
89    static ProcessedMap *createProcessedMap(const GR &G)
90    {
91      return new ProcessedMap();
92    }
93    ///The type of the map that indicates which nodes are reached.
94 
95    ///The type of the map that indicates which nodes are reached.
96    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
97    ///\todo named parameter to set this type, function to read and write.
98    typedef typename Graph::template NodeMap<bool> ReachedMap;
99    ///Instantiates a ReachedMap.
100 
101    ///This function instantiates a \ref ReachedMap.
102    ///\param G is the graph, to which
103    ///we would like to define the \ref ReachedMap.
104    static ReachedMap *createReachedMap(const GR &G)
105    {
106      return new ReachedMap(G);
107    }
108    ///The type of the map that stores the dists of the nodes.
109 
110    ///The type of the map that stores the dists of the nodes.
111    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
112    ///
113    typedef typename Graph::template NodeMap<int> DistMap;
114    ///Instantiates a DistMap.
115 
116    ///This function instantiates a \ref DistMap.
117    ///\param G is the graph, to which we would like to define the \ref DistMap
118    static DistMap *createDistMap(const GR &G)
119    {
120      return new DistMap(G);
121    }
122  };
123 
124  ///%DFS algorithm class.
125 
126  ///\ingroup flowalgs
127  ///This class provides an efficient implementation of the %DFS algorithm.
128  ///
129  ///\param GR The graph type the algorithm runs on. The default value is
130  ///\ref ListGraph. The value of GR is not used directly by Dfs, it
131  ///is only passed to \ref DfsDefaultTraits.
132  ///\param TR Traits class to set various data types used by the algorithm.
133  ///The default traits class is
134  ///\ref DfsDefaultTraits "DfsDefaultTraits<GR>".
135  ///See \ref DfsDefaultTraits for the documentation of
136  ///a Dfs traits class.
137  ///
138  ///\author Jacint Szabo and Alpar Juttner
139  ///\todo A compare object would be nice.
140
141#ifdef DOXYGEN
142  template <typename GR,
143            typename TR>
144#else
145  template <typename GR=ListGraph,
146            typename TR=DfsDefaultTraits<GR> >
147#endif
148  class Dfs {
149  public:
150    /**
151     * \brief \ref Exception for uninitialized parameters.
152     *
153     * This error represents problems in the initialization
154     * of the parameters of the algorithms.
155     */
156    class UninitializedParameter : public lemon::UninitializedParameter {
157    public:
158      virtual const char* exceptionName() const {
159        return "lemon::Dfs::UninitializedParameter";
160      }
161    };
162
163    typedef TR Traits;
164    ///The type of the underlying graph.
165    typedef typename TR::Graph Graph;
166    ///\e
167    typedef typename Graph::Node Node;
168    ///\e
169    typedef typename Graph::NodeIt NodeIt;
170    ///\e
171    typedef typename Graph::Edge Edge;
172    ///\e
173    typedef typename Graph::OutEdgeIt OutEdgeIt;
174   
175    ///\brief The type of the map that stores the last
176    ///edges of the %DFS paths.
177    typedef typename TR::PredMap PredMap;
178//     ///\brief The type of the map that stores the last but one
179//     ///nodes of the %DFS paths.
180//     typedef typename TR::PredNodeMap PredNodeMap;
181    ///The type of the map indicating which nodes are reached.
182    typedef typename TR::ReachedMap ReachedMap;
183    ///The type of the map indicating which nodes are processed.
184    typedef typename TR::ProcessedMap ProcessedMap;
185    ///The type of the map that stores the dists of the nodes.
186    typedef typename TR::DistMap DistMap;
187  private:
188    /// Pointer to the underlying graph.
189    const Graph *G;
190    ///Pointer to the map of predecessors edges.
191    PredMap *_pred;
192    ///Indicates if \ref _pred is locally allocated (\c true) or not.
193    bool local_pred;
194//     ///Pointer to the map of predecessors nodes.
195//     PredNodeMap *_predNode;
196//     ///Indicates if \ref _predNode is locally allocated (\c true) or not.
197//     bool local_predNode;
198    ///Pointer to the map of distances.
199    DistMap *_dist;
200    ///Indicates if \ref _dist is locally allocated (\c true) or not.
201    bool local_dist;
202    ///Pointer to the map of reached status of the nodes.
203    ReachedMap *_reached;
204    ///Indicates if \ref _reached is locally allocated (\c true) or not.
205    bool local_reached;
206    ///Pointer to the map of processed status of the nodes.
207    ProcessedMap *_processed;
208    ///Indicates if \ref _processed is locally allocated (\c true) or not.
209    bool local_processed;
210
211    std::vector<typename Graph::OutEdgeIt> _stack;
212    int _stack_head;
213//     ///The source node of the last execution.
214//     Node source;
215
216    ///Creates the maps if necessary.
217   
218    ///\todo Error if \c G are \c NULL.
219    ///\todo Better memory allocation (instead of new).
220    void create_maps()
221    {
222      if(!_pred) {
223        local_pred = true;
224        _pred = Traits::createPredMap(*G);
225      }
226//       if(!_predNode) {
227//      local_predNode = true;
228//      _predNode = Traits::createPredNodeMap(*G);
229//       }
230      if(!_dist) {
231        local_dist = true;
232        _dist = Traits::createDistMap(*G);
233      }
234      if(!_reached) {
235        local_reached = true;
236        _reached = Traits::createReachedMap(*G);
237      }
238      if(!_processed) {
239        local_processed = true;
240        _processed = Traits::createProcessedMap(*G);
241      }
242    }
243   
244  public :
245 
246    ///\name Named template parameters
247
248    ///@{
249
250    template <class T>
251    struct DefPredMapTraits : public Traits {
252      typedef T PredMap;
253      static PredMap *createPredMap(const Graph &G)
254      {
255        throw UninitializedParameter();
256      }
257    };
258    ///\ref named-templ-param "Named parameter" for setting PredMap type
259
260    ///\ref named-templ-param "Named parameter" for setting PredMap type
261    ///
262    template <class T>
263    class DefPredMap : public Dfs< Graph,
264                                        DefPredMapTraits<T> > { };
265   
266//     template <class T>
267//     struct DefPredNodeMapTraits : public Traits {
268//       typedef T PredNodeMap;
269//       static PredNodeMap *createPredNodeMap(const Graph &G)
270//       {
271//      throw UninitializedParameter();
272//       }
273//     };
274//     ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
275
276//     ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
277//     ///
278//     template <class T>
279//     class DefPredNodeMap : public Dfs< Graph,
280//                                          LengthMap,
281//                                          DefPredNodeMapTraits<T> > { };
282   
283    template <class T>
284    struct DefDistMapTraits : public Traits {
285      typedef T DistMap;
286      static DistMap *createDistMap(const Graph &G)
287      {
288        throw UninitializedParameter();
289      }
290    };
291    ///\ref named-templ-param "Named parameter" for setting DistMap type
292
293    ///\ref named-templ-param "Named parameter" for setting DistMap type
294    ///
295    template <class T>
296    class DefDistMap : public Dfs< Graph,
297                                   DefDistMapTraits<T> > { };
298   
299    template <class T>
300    struct DefReachedMapTraits : public Traits {
301      typedef T ReachedMap;
302      static ReachedMap *createReachedMap(const Graph &G)
303      {
304        throw UninitializedParameter();
305      }
306    };
307    ///\ref named-templ-param "Named parameter" for setting ReachedMap type
308
309    ///\ref named-templ-param "Named parameter" for setting ReachedMap type
310    ///
311    template <class T>
312    class DefReachedMap : public Dfs< Graph,
313                                      DefReachedMapTraits<T> > { };
314   
315    struct DefGraphReachedMapTraits : public Traits {
316      typedef typename Graph::template NodeMap<bool> ReachedMap;
317      static ReachedMap *createReachedMap(const Graph &G)
318      {
319        return new ReachedMap(G);
320      }
321    };
322    template <class T>
323    struct DefProcessedMapTraits : public Traits {
324      typedef T ProcessedMap;
325      static ProcessedMap *createProcessedMap(const Graph &G)
326      {
327        throw UninitializedParameter();
328      }
329    };
330    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
331
332    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
333    ///
334    template <class T>
335    class DefProcessedMap : public Dfs< Graph,
336                                        DefProcessedMapTraits<T> > { };
337   
338    struct DefGraphProcessedMapTraits : public Traits {
339      typedef typename Graph::template NodeMap<bool> ProcessedMap;
340      static ProcessedMap *createProcessedMap(const Graph &G)
341      {
342        return new ProcessedMap(G);
343      }
344    };
345    ///\brief \ref named-templ-param "Named parameter"
346    ///for setting the ProcessedMap type to be Graph::NodeMap<bool>.
347    ///
348    ///\ref named-templ-param "Named parameter"
349    ///for setting the ProcessedMap type to be Graph::NodeMap<bool>.
350    ///If you don't set it explicitely, it will be automatically allocated.
351    template <class T>
352    class DefProcessedMapToBeDefaultMap :
353      public Dfs< Graph,
354                  DefGraphProcessedMapTraits> { };
355   
356    ///@}
357
358  public:     
359   
360    ///Constructor.
361   
362    ///\param _G the graph the algorithm will run on.
363    ///
364    Dfs(const Graph& _G) :
365      G(&_G),
366      _pred(NULL), local_pred(false),
367//       _predNode(NULL), local_predNode(false),
368      _dist(NULL), local_dist(false),
369      _reached(NULL), local_reached(false),
370      _processed(NULL), local_processed(false)
371    { }
372   
373    ///Destructor.
374    ~Dfs()
375    {
376      if(local_pred) delete _pred;
377//       if(local_predNode) delete _predNode;
378      if(local_dist) delete _dist;
379      if(local_reached) delete _reached;
380      if(local_processed) delete _processed;
381    }
382
383    ///Sets the map storing the predecessor edges.
384
385    ///Sets the map storing the predecessor edges.
386    ///If you don't use this function before calling \ref run(),
387    ///it will allocate one. The destuctor deallocates this
388    ///automatically allocated map, of course.
389    ///\return <tt> (*this) </tt>
390    Dfs &predMap(PredMap &m)
391    {
392      if(local_pred) {
393        delete _pred;
394        local_pred=false;
395      }
396      _pred = &m;
397      return *this;
398    }
399
400//     ///Sets the map storing the predecessor nodes.
401
402//     ///Sets the map storing the predecessor nodes.
403//     ///If you don't use this function before calling \ref run(),
404//     ///it will allocate one. The destuctor deallocates this
405//     ///automatically allocated map, of course.
406//     ///\return <tt> (*this) </tt>
407//     Dfs &predNodeMap(PredNodeMap &m)
408//     {
409//       if(local_predNode) {
410//      delete _predNode;
411//      local_predNode=false;
412//       }
413//       _predNode = &m;
414//       return *this;
415//     }
416
417    ///Sets the map storing the distances calculated by the algorithm.
418
419    ///Sets the map storing the distances calculated by the algorithm.
420    ///If you don't use this function before calling \ref run(),
421    ///it will allocate one. The destuctor deallocates this
422    ///automatically allocated map, of course.
423    ///\return <tt> (*this) </tt>
424    Dfs &distMap(DistMap &m)
425    {
426      if(local_dist) {
427        delete _dist;
428        local_dist=false;
429      }
430      _dist = &m;
431      return *this;
432    }
433
434    ///Sets the map indicating if a node is reached.
435
436    ///Sets the map indicating if a node is reached.
437    ///If you don't use this function before calling \ref run(),
438    ///it will allocate one. The destuctor deallocates this
439    ///automatically allocated map, of course.
440    ///\return <tt> (*this) </tt>
441    Dfs &reachedMap(ReachedMap &m)
442    {
443      if(local_reached) {
444        delete _reached;
445        local_reached=false;
446      }
447      _reached = &m;
448      return *this;
449    }
450
451    ///Sets the map indicating if a node is processed.
452
453    ///Sets the map indicating if a node is processed.
454    ///If you don't use this function before calling \ref run(),
455    ///it will allocate one. The destuctor deallocates this
456    ///automatically allocated map, of course.
457    ///\return <tt> (*this) </tt>
458    Dfs &processedMap(ProcessedMap &m)
459    {
460      if(local_processed) {
461        delete _processed;
462        local_processed=false;
463      }
464      _processed = &m;
465      return *this;
466    }
467
468  public:
469    ///\name Execution control
470    ///The simplest way to execute the algorithm is to use
471    ///one of the member functions called \c run(...).
472    ///\n
473    ///If you need more control on the execution,
474    ///first you must call \ref init(), then you can add several source nodes
475    ///with \ref addSource().
476    ///Finally \ref start() will perform the actual path
477    ///computation.
478
479    ///@{
480
481    ///Initializes the internal data structures.
482
483    ///Initializes the internal data structures.
484    ///
485    void init()
486    {
487      create_maps();
488      _stack.resize(countNodes(*G));
489      _stack_head=-1;
490      for ( NodeIt u(*G) ; u!=INVALID ; ++u ) {
491        _pred->set(u,INVALID);
492        // _predNode->set(u,INVALID);
493        _reached->set(u,false);
494        _processed->set(u,false);
495      }
496    }
497   
498    ///Adds a new source node.
499
500    ///Adds a new source node to the set of nodes to be processed.
501    ///
502    ///\bug dist's are wrong (or at least strange) in case of multiple sources.
503    void addSource(Node s)
504    {
505      if(!(*_reached)[s])
506        {
507          _reached->set(s,true);
508          _pred->set(s,INVALID);
509          // _predNode->set(u,INVALID);
510          _stack[++_stack_head]=OutEdgeIt(*G,s);
511          _dist->set(s,_stack_head);
512        }
513    }
514   
515    ///Processes the next node.
516
517    ///Processes the next node.
518    ///
519    ///\warning The stack must not be empty!
520    void processNextEdge()
521    {
522      Node m;
523      Edge e=_stack[_stack_head];
524      if(!(*_reached)[m=G->target(e)]) {
525        _pred->set(m,e);
526        _reached->set(m,true);
527        //        _pred_node->set(m,G->source(e));
528        _stack[++_stack_head] = OutEdgeIt(*G, m);
529        _dist->set(m,_stack_head);
530      }
531      else {
532        Node n;
533        while(_stack_head>=0 &&
534              (n=G->source(_stack[_stack_head]),
535               ++_stack[_stack_head]==INVALID))
536          {
537            _processed->set(n,true);
538            --_stack_head;
539          }
540      }
541    }
542     
543    ///\brief Returns \c false if there are nodes
544    ///to be processed in the queue
545    ///
546    ///Returns \c false if there are nodes
547    ///to be processed in the queue
548    bool emptyQueue() { return _stack_head<0; }
549    ///Returns the number of the nodes to be processed.
550   
551    ///Returns the number of the nodes to be processed in the queue.
552    ///
553    int queueSize() { return _stack_head+1; }
554   
555    ///Executes the algorithm.
556
557    ///Executes the algorithm.
558    ///
559    ///\pre init() must be called and at least one node should be added
560    ///with addSource() before using this function.
561    ///
562    ///This method runs the %DFS algorithm from the root node(s)
563    ///in order to
564    ///compute the
565    ///%DFS path to each node. The algorithm computes
566    ///- The %DFS tree.
567    ///- The distance of each node from the root(s).
568    ///
569    void start()
570    {
571      while ( !emptyQueue() ) processNextEdge();
572    }
573   
574    ///Executes the algorithm until \c dest is reached.
575
576    ///Executes the algorithm until \c dest is reached.
577    ///
578    ///\pre init() must be called and at least one node should be added
579    ///with addSource() before using this function.
580    ///
581    ///This method runs the %DFS algorithm from the root node(s)
582    ///in order to
583    ///compute the
584    ///%DFS path to \c dest. The algorithm computes
585    ///- The %DFS path to \c  dest.
586    ///- The distance of \c dest from the root(s).
587    ///
588    void start(Node dest)
589    {
590      while ( !emptyQueue() && _queue[_queue_tail]!=dest ) processNextEdge();
591    }
592   
593    ///Executes the algorithm until a condition is met.
594
595    ///Executes the algorithm until a condition is met.
596    ///
597    ///\pre init() must be called and at least one node should be added
598    ///with addSource() before using this function.
599    ///
600    ///\param nm must be a bool (or convertible) node map. The algorithm
601    ///will stop when it reaches a node \c v with <tt>nm[v]==true</tt>.
602    template<class NM>
603      void start(const NM &nm)
604      {
605        while ( !emptyQueue() && !nm[_queue[_queue_tail]] ) processNextEdge();
606      }
607   
608    ///Runs %DFS algorithm from node \c s.
609   
610    ///This method runs the %DFS algorithm from a root node \c s
611    ///in order to
612    ///compute the
613    ///%DFS path to each node. The algorithm computes
614    ///- The %DFS tree.
615    ///- The distance of each node from the root.
616    ///
617    ///\note d.run(s) is just a shortcut of the following code.
618    ///\code
619    ///  d.init();
620    ///  d.addSource(s);
621    ///  d.start();
622    ///\endcode
623    void run(Node s) {
624      init();
625      addSource(s);
626      start();
627    }
628   
629    ///Finds the %DFS path between \c s and \c t.
630   
631    ///Finds the %DFS path between \c s and \c t.
632    ///
633    ///\return The length of the %DFS s---t path if there exists one,
634    ///0 otherwise.
635    ///\note Apart from the return value, d.run(s) is
636    ///just a shortcut of the following code.
637    ///\code
638    ///  d.init();
639    ///  d.addSource(s);
640    ///  d.start(t);
641    ///\endcode
642    int run(Node s,Node t) {
643      init();
644      addSource(s);
645      start(t);
646      return reached(t)?_curr_dist-1+(_queue_tail==_queue_next_dist):0;
647    }
648   
649    ///@}
650
651    ///\name Query Functions
652    ///The result of the %DFS algorithm can be obtained using these
653    ///functions.\n
654    ///Before the use of these functions,
655    ///either run() or start() must be called.
656   
657    ///@{
658
659    ///The distance of a node from the root(s).
660
661    ///Returns the distance of a node from the root(s).
662    ///\pre \ref run() must be called before using this function.
663    ///\warning If node \c v in unreachable from the root(s) the return value
664    ///of this funcion is undefined.
665    int dist(Node v) const { return (*_dist)[v]; }
666
667    ///Returns the 'previous edge' of the %DFS tree.
668
669    ///For a node \c v it returns the 'previous edge'
670    ///of the %DFS path,
671    ///i.e. it returns the last edge of a %DFS path from the root(s) to \c
672    ///v. It is \ref INVALID
673    ///if \c v is unreachable from the root(s) or \c v is a root. The
674    ///%DFS tree used here is equal to the %DFS tree used in
675    ///\ref predNode(Node v).
676    ///\pre Either \ref run() or \ref start() must be called before using
677    ///this function.
678    ///\todo predEdge could be a better name.
679    Edge pred(Node v) const { return (*_pred)[v];}
680
681    ///Returns the 'previous node' of the %DFS tree.
682
683    ///For a node \c v it returns the 'previous node'
684    ///of the %DFS tree,
685    ///i.e. it returns the last but one node from a %DFS path from the
686    ///root(a) to \c /v.
687    ///It is INVALID if \c v is unreachable from the root(s) or
688    ///if \c v itself a root.
689    ///The %DFS tree used here is equal to the %DFS
690    ///tree used in \ref pred(Node v).
691    ///\pre Either \ref run() or \ref start() must be called before
692    ///using this function.
693    Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:
694                                  G->source((*_pred)[v]); }
695   
696    ///Returns a reference to the NodeMap of distances.
697
698    ///Returns a reference to the NodeMap of distances.
699    ///\pre Either \ref run() or \ref init() must
700    ///be called before using this function.
701    const DistMap &distMap() const { return *_dist;}
702 
703    ///Returns a reference to the %DFS edge-tree map.
704
705    ///Returns a reference to the NodeMap of the edges of the
706    ///%DFS tree.
707    ///\pre Either \ref run() or \ref init()
708    ///must be called before using this function.
709    const PredMap &predMap() const { return *_pred;}
710 
711//     ///Returns a reference to the map of nodes of %DFS paths.
712
713//     ///Returns a reference to the NodeMap of the last but one nodes of the
714//     ///%DFS tree.
715//     ///\pre \ref run() must be called before using this function.
716//     const PredNodeMap &predNodeMap() const { return *_predNode;}
717
718    ///Checks if a node is reachable from the root.
719
720    ///Returns \c true if \c v is reachable from the root.
721    ///\warning The source nodes are inditated as unreached.
722    ///\pre Either \ref run() or \ref start()
723    ///must be called before using this function.
724    ///
725    bool reached(Node v) { return (*_reached)[v]; }
726   
727    ///@}
728  };
729
730  ///Default traits class of Dfs function.
731
732  ///Default traits class of Dfs function.
733  ///\param GR Graph type.
734  template<class GR>
735  struct DfsWizardDefaultTraits
736  {
737    ///The graph type the algorithm runs on.
738    typedef GR Graph;
739    ///\brief The type of the map that stores the last
740    ///edges of the %DFS paths.
741    ///
742    ///The type of the map that stores the last
743    ///edges of the %DFS paths.
744    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
745    ///
746    typedef NullMap<typename Graph::Node,typename GR::Edge> PredMap;
747    ///Instantiates a PredMap.
748 
749    ///This function instantiates a \ref PredMap.
750    ///\param G is the graph, to which we would like to define the PredMap.
751    ///\todo The graph alone may be insufficient to initialize
752    static PredMap *createPredMap(const GR &G)
753    {
754      return new PredMap();
755    }
756//     ///\brief The type of the map that stores the last but one
757//     ///nodes of the %DFS paths.
758//     ///
759//     ///The type of the map that stores the last but one
760//     ///nodes of the %DFS paths.
761//     ///It must meet the \ref concept::WriteMap "WriteMap" concept.
762//     ///
763//     typedef NullMap<typename Graph::Node,typename Graph::Node> PredNodeMap;
764//     ///Instantiates a PredNodeMap.
765   
766//     ///This function instantiates a \ref PredNodeMap.
767//     ///\param G is the graph, to which
768//     ///we would like to define the \ref PredNodeMap
769//     static PredNodeMap *createPredNodeMap(const GR &G)
770//     {
771//       return new PredNodeMap();
772//     }
773
774    ///The type of the map that indicates which nodes are processed.
775 
776    ///The type of the map that indicates which nodes are processed.
777    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
778    ///\todo named parameter to set this type, function to read and write.
779    typedef NullMap<typename Graph::Node,bool> ProcessedMap;
780    ///Instantiates a ProcessedMap.
781 
782    ///This function instantiates a \ref ProcessedMap.
783    ///\param G is the graph, to which
784    ///we would like to define the \ref ProcessedMap
785    static ProcessedMap *createProcessedMap(const GR &G)
786    {
787      return new ProcessedMap();
788    }
789    ///The type of the map that indicates which nodes are reached.
790 
791    ///The type of the map that indicates which nodes are reached.
792    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
793    ///\todo named parameter to set this type, function to read and write.
794    typedef typename Graph::template NodeMap<bool> ReachedMap;
795    ///Instantiates a ReachedMap.
796 
797    ///This function instantiates a \ref ReachedMap.
798    ///\param G is the graph, to which
799    ///we would like to define the \ref ReachedMap.
800    static ReachedMap *createReachedMap(const GR &G)
801    {
802      return new ReachedMap(G);
803    }
804    ///The type of the map that stores the dists of the nodes.
805 
806    ///The type of the map that stores the dists of the nodes.
807    ///It must meet the \ref concept::WriteMap "WriteMap" concept.
808    ///
809    typedef NullMap<typename Graph::Node,int> DistMap;
810    ///Instantiates a DistMap.
811 
812    ///This function instantiates a \ref DistMap.
813    ///\param G is the graph, to which we would like to define the \ref DistMap
814    static DistMap *createDistMap(const GR &G)
815    {
816      return new DistMap();
817    }
818  };
819 
820  /// Default traits used by \ref DfsWizard
821
822  /// To make it easier to use Dfs algorithm
823  ///we have created a wizard class.
824  /// This \ref DfsWizard class needs default traits,
825  ///as well as the \ref Dfs class.
826  /// The \ref DfsWizardBase is a class to be the default traits of the
827  /// \ref DfsWizard class.
828  template<class GR>
829  class DfsWizardBase : public DfsWizardDefaultTraits<GR>
830  {
831
832    typedef DfsWizardDefaultTraits<GR> Base;
833  protected:
834    /// Type of the nodes in the graph.
835    typedef typename Base::Graph::Node Node;
836
837    /// Pointer to the underlying graph.
838    void *_g;
839    ///Pointer to the map of reached nodes.
840    void *_reached;
841    ///Pointer to the map of processed nodes.
842    void *_processed;
843    ///Pointer to the map of predecessors edges.
844    void *_pred;
845//     ///Pointer to the map of predecessors nodes.
846//     void *_predNode;
847    ///Pointer to the map of distances.
848    void *_dist;
849    ///Pointer to the source node.
850    Node _source;
851   
852    public:
853    /// Constructor.
854   
855    /// This constructor does not require parameters, therefore it initiates
856    /// all of the attributes to default values (0, INVALID).
857    DfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0),
858//                         _predNode(0),
859                           _dist(0), _source(INVALID) {}
860
861    /// Constructor.
862   
863    /// This constructor requires some parameters,
864    /// listed in the parameters list.
865    /// Others are initiated to 0.
866    /// \param g is the initial value of  \ref _g
867    /// \param s is the initial value of  \ref _source
868    DfsWizardBase(const GR &g, Node s=INVALID) :
869      _g((void *)&g), _reached(0), _processed(0), _pred(0),
870//       _predNode(0),
871      _dist(0), _source(s) {}
872
873  };
874 
875  /// A class to make the usage of Dfs algorithm easier
876
877  /// This class is created to make it easier to use Dfs algorithm.
878  /// It uses the functions and features of the plain \ref Dfs,
879  /// but it is much simpler to use it.
880  ///
881  /// Simplicity means that the way to change the types defined
882  /// in the traits class is based on functions that returns the new class
883  /// and not on templatable built-in classes.
884  /// When using the plain \ref Dfs
885  /// the new class with the modified type comes from
886  /// the original class by using the ::
887  /// operator. In the case of \ref DfsWizard only
888  /// a function have to be called and it will
889  /// return the needed class.
890  ///
891  /// It does not have own \ref run method. When its \ref run method is called
892  /// it initiates a plain \ref Dfs class, and calls the \ref Dfs::run
893  /// method of it.
894  template<class TR>
895  class DfsWizard : public TR
896  {
897    typedef TR Base;
898
899    ///The type of the underlying graph.
900    typedef typename TR::Graph Graph;
901    //\e
902    typedef typename Graph::Node Node;
903    //\e
904    typedef typename Graph::NodeIt NodeIt;
905    //\e
906    typedef typename Graph::Edge Edge;
907    //\e
908    typedef typename Graph::OutEdgeIt OutEdgeIt;
909   
910    ///\brief The type of the map that stores
911    ///the reached nodes
912    typedef typename TR::ReachedMap ReachedMap;
913    ///\brief The type of the map that stores
914    ///the processed nodes
915    typedef typename TR::ProcessedMap ProcessedMap;
916    ///\brief The type of the map that stores the last
917    ///edges of the %DFS paths.
918    typedef typename TR::PredMap PredMap;
919//     ///\brief The type of the map that stores the last but one
920//     ///nodes of the %DFS paths.
921//     typedef typename TR::PredNodeMap PredNodeMap;
922    ///The type of the map that stores the dists of the nodes.
923    typedef typename TR::DistMap DistMap;
924
925public:
926    /// Constructor.
927    DfsWizard() : TR() {}
928
929    /// Constructor that requires parameters.
930
931    /// Constructor that requires parameters.
932    /// These parameters will be the default values for the traits class.
933    DfsWizard(const Graph &g, Node s=INVALID) :
934      TR(g,s) {}
935
936    ///Copy constructor
937    DfsWizard(const TR &b) : TR(b) {}
938
939    ~DfsWizard() {}
940
941    ///Runs Dfs algorithm from a given node.
942   
943    ///Runs Dfs algorithm from a given node.
944    ///The node can be given by the \ref source function.
945    void run()
946    {
947      if(Base::_source==INVALID) throw UninitializedParameter();
948      Dfs<Graph,TR> alg(*(Graph*)Base::_g);
949      if(Base::_reached) alg.reachedMap(*(ReachedMap*)Base::_reached);
950      if(Base::_processed) alg.processedMap(*(ProcessedMap*)Base::_processed);
951      if(Base::_pred) alg.predMap(*(PredMap*)Base::_pred);
952//       if(Base::_predNode) alg.predNodeMap(*(PredNodeMap*)Base::_predNode);
953      if(Base::_dist) alg.distMap(*(DistMap*)Base::_dist);
954      alg.run(Base::_source);
955    }
956
957    ///Runs Dfs algorithm from the given node.
958
959    ///Runs Dfs algorithm from the given node.
960    ///\param s is the given source.
961    void run(Node s)
962    {
963      Base::_source=s;
964      run();
965    }
966
967    template<class T>
968    struct DefPredMapBase : public Base {
969      typedef T PredMap;
970      static PredMap *createPredMap(const Graph &G) { return 0; };
971      DefPredMapBase(const Base &b) : Base(b) {}
972    };
973   
974    ///\brief \ref named-templ-param "Named parameter"
975    ///function for setting PredMap type
976    ///
977    /// \ref named-templ-param "Named parameter"
978    ///function for setting PredMap type
979    ///
980    template<class T>
981    DfsWizard<DefPredMapBase<T> > predMap(const T &t)
982    {
983      Base::_pred=(void *)&t;
984      return DfsWizard<DefPredMapBase<T> >(*this);
985    }
986   
987 
988    template<class T>
989    struct DefReachedMapBase : public Base {
990      typedef T ReachedMap;
991      static ReachedMap *createReachedMap(const Graph &G) { return 0; };
992      DefReachedMapBase(const Base &b) : Base(b) {}
993    };
994   
995    ///\brief \ref named-templ-param "Named parameter"
996    ///function for setting ReachedMap
997    ///
998    /// \ref named-templ-param "Named parameter"
999    ///function for setting ReachedMap
1000    ///
1001    template<class T>
1002    DfsWizard<DefReachedMapBase<T> > reachedMap(const T &t)
1003    {
1004      Base::_pred=(void *)&t;
1005      return DfsWizard<DefReachedMapBase<T> >(*this);
1006    }
1007   
1008
1009    template<class T>
1010    struct DefProcessedMapBase : public Base {
1011      typedef T ProcessedMap;
1012      static ProcessedMap *createProcessedMap(const Graph &G) { return 0; };
1013      DefProcessedMapBase(const Base &b) : Base(b) {}
1014    };
1015   
1016    ///\brief \ref named-templ-param "Named parameter"
1017    ///function for setting ProcessedMap
1018    ///
1019    /// \ref named-templ-param "Named parameter"
1020    ///function for setting ProcessedMap
1021    ///
1022    template<class T>
1023    DfsWizard<DefProcessedMapBase<T> > processedMap(const T &t)
1024    {
1025      Base::_pred=(void *)&t;
1026      return DfsWizard<DefProcessedMapBase<T> >(*this);
1027    }
1028   
1029
1030//     template<class T>
1031//     struct DefPredNodeMapBase : public Base {
1032//       typedef T PredNodeMap;
1033//       static PredNodeMap *createPredNodeMap(const Graph &G) { return 0; };
1034//       DefPredNodeMapBase(const Base &b) : Base(b) {}
1035//     };
1036   
1037//     ///\brief \ref named-templ-param "Named parameter"
1038//     ///function for setting PredNodeMap type
1039//     ///
1040//     /// \ref named-templ-param "Named parameter"
1041//     ///function for setting PredNodeMap type
1042//     ///
1043//     template<class T>
1044//     DfsWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t)
1045//     {
1046//       Base::_predNode=(void *)&t;
1047//       return DfsWizard<DefPredNodeMapBase<T> >(*this);
1048//     }
1049   
1050    template<class T>
1051    struct DefDistMapBase : public Base {
1052      typedef T DistMap;
1053      static DistMap *createDistMap(const Graph &G) { return 0; };
1054      DefDistMapBase(const Base &b) : Base(b) {}
1055    };
1056   
1057    ///\brief \ref named-templ-param "Named parameter"
1058    ///function for setting DistMap type
1059    ///
1060    /// \ref named-templ-param "Named parameter"
1061    ///function for setting DistMap type
1062    ///
1063    template<class T>
1064    DfsWizard<DefDistMapBase<T> > distMap(const T &t)
1065    {
1066      Base::_dist=(void *)&t;
1067      return DfsWizard<DefDistMapBase<T> >(*this);
1068    }
1069   
1070    /// Sets the source node, from which the Dfs algorithm runs.
1071
1072    /// Sets the source node, from which the Dfs algorithm runs.
1073    /// \param s is the source node.
1074    DfsWizard<TR> &source(Node s)
1075    {
1076      Base::_source=s;
1077      return *this;
1078    }
1079   
1080  };
1081 
1082  ///Function type interface for Dfs algorithm.
1083
1084  /// \ingroup flowalgs
1085  ///Function type interface for Dfs algorithm.
1086  ///
1087  ///This function also has several
1088  ///\ref named-templ-func-param "named parameters",
1089  ///they are declared as the members of class \ref DfsWizard.
1090  ///The following
1091  ///example shows how to use these parameters.
1092  ///\code
1093  ///  dfs(g,source).predMap(preds).run();
1094  ///\endcode
1095  ///\warning Don't forget to put the \ref DfsWizard::run() "run()"
1096  ///to the end of the parameter list.
1097  ///\sa DfsWizard
1098  ///\sa Dfs
1099  template<class GR>
1100  DfsWizard<DfsWizardBase<GR> >
1101  dfs(const GR &g,typename GR::Node s=INVALID)
1102  {
1103    return DfsWizard<DfsWizardBase<GR> >(g,s);
1104  }
1105
1106} //END OF NAMESPACE LEMON
1107
1108#endif
1109
Note: See TracBrowser for help on using the repository browser.