- A primitive function type interface for Preflow.
- A compilation bug fixed
2 * src/lemon/dijkstra.h - Part of LEMON, a generic C++ optimization library
4 * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
5 * (Egervary Combinatorial Optimization Research Group, EGRES).
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.
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
17 #ifndef LEMON_DIJKSTRA_H
18 #define LEMON_DIJKSTRA_H
22 ///\brief Dijkstra algorithm.
24 #include <lemon/list_graph.h>
25 #include <lemon/bin_heap.h>
26 #include <lemon/invalid.h>
27 #include <lemon/error.h>
28 #include <lemon/maps.h>
34 ///Default traits class of Dijkstra class.
36 ///Default traits class of Dijkstra class.
37 ///\param GR Graph type.
38 ///\param LM Type of length map.
39 template<class GR, class LM>
40 struct DijkstraDefaultTraits
42 ///The graph type the algorithm runs on.
44 ///The type of the map that stores the edge lengths.
46 ///The type of the map that stores the edge lengths.
47 ///It must meet the \ref concept::ReadMap "ReadMap" concept.
49 //The type of the length of the edges.
50 typedef typename LM::Value Value;
51 ///The heap type used by Dijkstra algorithm.
53 ///The heap type used by Dijkstra algorithm.
57 typedef BinHeap<typename Graph::Node,
59 typename GR::template NodeMap<int>,
60 std::less<Value> > Heap;
62 ///\brief The type of the map that stores the last
63 ///edges of the shortest paths.
65 ///The type of the map that stores the last
66 ///edges of the shortest paths.
67 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
69 typedef typename Graph::template NodeMap<typename GR::Edge> PredMap;
70 ///Instantiates a PredMap.
72 ///This function instantiates a \ref PredMap.
73 ///\param G is the graph, to which we would like to define the PredMap.
74 ///\todo The graph alone may be insufficient for the initialization
75 static PredMap *createPredMap(const GR &G)
77 return new PredMap(G);
79 // ///\brief The type of the map that stores the last but one
80 // ///nodes of the shortest paths.
82 // ///The type of the map that stores the last but one
83 // ///nodes of the shortest paths.
84 // ///It must meet the \ref concept::WriteMap "WriteMap" concept.
86 // typedef NullMap<typename Graph::Node,typename Graph::Node> PredNodeMap;
87 // ///Instantiates a PredNodeMap.
89 // ///This function instantiates a \ref PredNodeMap.
90 // ///\param G is the graph, to which
91 // ///we would like to define the \ref PredNodeMap
92 // static PredNodeMap *createPredNodeMap(const GR &G)
94 // return new PredNodeMap();
97 ///The type of the map that stores whether a nodes is processed.
99 ///The type of the map that stores whether a nodes is processed.
100 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
101 ///By default it is a NullMap.
102 ///\todo If it is set to a real map,
103 ///Dijkstra::processed() should read this.
104 ///\todo named parameter to set this type, function to read and write.
105 typedef NullMap<typename Graph::Node,bool> ProcessedMap;
106 ///Instantiates a ProcessedMap.
108 ///This function instantiates a \ref ProcessedMap.
109 ///\param G is the graph, to which
110 ///we would like to define the \ref ProcessedMap
111 static ProcessedMap *createProcessedMap(const GR &G)
113 return new ProcessedMap();
115 ///The type of the map that stores the dists of the nodes.
117 ///The type of the map that stores the dists of the nodes.
118 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
120 typedef typename Graph::template NodeMap<typename LM::Value> DistMap;
121 ///Instantiates a DistMap.
123 ///This function instantiates a \ref DistMap.
124 ///\param G is the graph, to which we would like to define the \ref DistMap
125 static DistMap *createDistMap(const GR &G)
127 return new DistMap(G);
131 ///%Dijkstra algorithm class.
133 /// \ingroup flowalgs
134 ///This class provides an efficient implementation of %Dijkstra algorithm.
135 ///The edge lengths are passed to the algorithm using a
136 ///\ref concept::ReadMap "ReadMap",
137 ///so it is easy to change it to any kind of length.
139 ///The type of the length is determined by the
140 ///\ref concept::ReadMap::Value "Value" of the length map.
142 ///It is also possible to change the underlying priority heap.
144 ///\param GR The graph type the algorithm runs on. The default value
145 ///is \ref ListGraph. The value of GR is not used directly by
146 ///Dijkstra, it is only passed to \ref DijkstraDefaultTraits.
147 ///\param LM This read-only EdgeMap determines the lengths of the
148 ///edges. It is read once for each edge, so the map may involve in
149 ///relatively time consuming process to compute the edge length if
150 ///it is necessary. The default map type is \ref
151 ///concept::StaticGraph::EdgeMap "Graph::EdgeMap<int>". The value
152 ///of LM is not used directly by Dijkstra, it is only passed to \ref
153 ///DijkstraDefaultTraits. \param TR Traits class to set
154 ///various data types used by the algorithm. The default traits
155 ///class is \ref DijkstraDefaultTraits
156 ///"DijkstraDefaultTraits<GR,LM>". See \ref
157 ///DijkstraDefaultTraits for the documentation of a Dijkstra traits
160 ///\author Jacint Szabo and Alpar Juttner
161 ///\todo A compare object would be nice.
164 template <typename GR,
168 template <typename GR=ListGraph,
169 typename LM=typename GR::template EdgeMap<int>,
170 typename TR=DijkstraDefaultTraits<GR,LM> >
175 * \brief \ref Exception for uninitialized parameters.
177 * This error represents problems in the initialization
178 * of the parameters of the algorithms.
180 class UninitializedParameter : public lemon::UninitializedParameter {
182 virtual const char* exceptionName() const {
183 return "lemon::Dijkstra::UninitializedParameter";
188 ///The type of the underlying graph.
189 typedef typename TR::Graph Graph;
191 typedef typename Graph::Node Node;
193 typedef typename Graph::NodeIt NodeIt;
195 typedef typename Graph::Edge Edge;
197 typedef typename Graph::OutEdgeIt OutEdgeIt;
199 ///The type of the length of the edges.
200 typedef typename TR::LengthMap::Value Value;
201 ///The type of the map that stores the edge lengths.
202 typedef typename TR::LengthMap LengthMap;
203 ///\brief The type of the map that stores the last
204 ///edges of the shortest paths.
205 typedef typename TR::PredMap PredMap;
206 // ///\brief The type of the map that stores the last but one
207 // ///nodes of the shortest paths.
208 // typedef typename TR::PredNodeMap PredNodeMap;
209 ///The type of the map indicating if a node is processed.
210 typedef typename TR::ProcessedMap ProcessedMap;
211 ///The type of the map that stores the dists of the nodes.
212 typedef typename TR::DistMap DistMap;
213 ///The heap type used by the dijkstra algorithm.
214 typedef typename TR::Heap Heap;
216 /// Pointer to the underlying graph.
218 /// Pointer to the length map
219 const LengthMap *length;
220 ///Pointer to the map of predecessors edges.
222 ///Indicates if \ref _pred is locally allocated (\c true) or not.
224 // ///Pointer to the map of predecessors nodes.
225 // PredNodeMap *_predNode;
226 // ///Indicates if \ref _predNode is locally allocated (\c true) or not.
227 // bool local_predNode;
228 ///Pointer to the map of distances.
230 ///Indicates if \ref _dist is locally allocated (\c true) or not.
232 ///Pointer to the map of processed status of the nodes.
233 ProcessedMap *_processed;
234 ///Indicates if \ref _processed is locally allocated (\c true) or not.
235 bool local_processed;
237 // ///The source node of the last execution.
240 ///Creates the maps if necessary.
242 ///\todo Error if \c G or are \c NULL. What about \c length?
243 ///\todo Better memory allocation (instead of new).
248 _pred = Traits::createPredMap(*G);
251 // local_predNode = true;
252 // _predNode = Traits::createPredNodeMap(*G);
256 _dist = Traits::createDistMap(*G);
259 local_processed = true;
260 _processed = Traits::createProcessedMap(*G);
266 ///\name Named template parameters
271 struct DefPredMapTraits : public Traits {
273 static PredMap *createPredMap(const Graph &G)
275 throw UninitializedParameter();
278 ///\ref named-templ-param "Named parameter" for setting PredMap type
280 ///\ref named-templ-param "Named parameter" for setting PredMap type
283 class DefPredMap : public Dijkstra< Graph,
285 DefPredMapTraits<T> > { };
287 // template <class T>
288 // struct DefPredNodeMapTraits : public Traits {
289 // typedef T PredNodeMap;
290 // static PredNodeMap *createPredNodeMap(const Graph &G)
292 // throw UninitializedParameter();
295 // ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
297 // ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
299 // template <class T>
300 // class DefPredNodeMap : public Dijkstra< Graph,
302 // DefPredNodeMapTraits<T> > { };
305 struct DefDistMapTraits : public Traits {
307 static DistMap *createDistMap(const Graph &G)
309 throw UninitializedParameter();
312 ///\ref named-templ-param "Named parameter" for setting DistMap type
314 ///\ref named-templ-param "Named parameter" for setting DistMap type
317 class DefDistMap : public Dijkstra< Graph,
319 DefDistMapTraits<T> > { };
322 struct DefProcessedMapTraits : public Traits {
323 typedef T ProcessedMap;
324 static ProcessedMap *createProcessedMap(const Graph &G)
326 throw UninitializedParameter();
329 ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
331 ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
334 class DefProcessedMap : public Dijkstra< Graph,
336 DefProcessedMapTraits<T> > { };
338 struct DefGraphProcessedMapTraits : public Traits {
339 typedef typename Graph::template NodeMap<bool> ProcessedMap;
340 static ProcessedMap *createProcessedMap(const Graph &G)
342 return new ProcessedMap(G);
345 ///\brief \ref named-templ-param "Named parameter"
346 ///for setting the ProcessedMap type to be Graph::NodeMap<bool>.
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.
352 class DefProcessedMapToBeDefaultMap :
353 public Dijkstra< Graph,
355 DefGraphProcessedMapTraits> { };
361 typename Graph::template NodeMap<int> _heap_map;
367 ///\param _G the graph the algorithm will run on.
368 ///\param _length the length map used by the algorithm.
369 Dijkstra(const Graph& _G, const LengthMap& _length) :
370 G(&_G), length(&_length),
371 _pred(NULL), local_pred(false),
372 // _predNode(NULL), local_predNode(false),
373 _dist(NULL), local_dist(false),
374 _processed(NULL), local_processed(false),
375 _heap_map(*G,-1),_heap(_heap_map)
381 if(local_pred) delete _pred;
382 // if(local_predNode) delete _predNode;
383 if(local_dist) delete _dist;
384 if(local_processed) delete _processed;
387 ///Sets the length map.
389 ///Sets the length map.
390 ///\return <tt> (*this) </tt>
391 Dijkstra &lengthMap(const LengthMap &m)
397 ///Sets the map storing the predecessor edges.
399 ///Sets the map storing the predecessor edges.
400 ///If you don't use this function before calling \ref run(),
401 ///it will allocate one. The destuctor deallocates this
402 ///automatically allocated map, of course.
403 ///\return <tt> (*this) </tt>
404 Dijkstra &predMap(PredMap &m)
414 // ///Sets the map storing the predecessor nodes.
416 // ///Sets the map storing the predecessor nodes.
417 // ///If you don't use this function before calling \ref run(),
418 // ///it will allocate one. The destuctor deallocates this
419 // ///automatically allocated map, of course.
420 // ///\return <tt> (*this) </tt>
421 // Dijkstra &predNodeMap(PredNodeMap &m)
423 // if(local_predNode) {
425 // local_predNode=false;
431 ///Sets the map storing the distances calculated by the algorithm.
433 ///Sets the map storing the distances calculated by the algorithm.
434 ///If you don't use this function before calling \ref run(),
435 ///it will allocate one. The destuctor deallocates this
436 ///automatically allocated map, of course.
437 ///\return <tt> (*this) </tt>
438 Dijkstra &distMap(DistMap &m)
449 void finalizeNodeData(Node v,Value dst)
451 _processed->set(v,true);
453 // if((*_pred)[v]!=INVALID)
454 // _predNode->set(v,G->source((*_pred)[v])); ///\todo What to do?
458 ///\name Execution control
459 ///The simplest way to execute the algorithm is to use
460 ///one of the member functions called \c run(...).
462 ///If you need more control on the execution,
463 ///first you must call \ref init(), then you can add several source nodes
464 ///with \ref addSource().
465 ///Finally \ref start() will perform the actual path
470 ///Initializes the internal data structures.
472 ///Initializes the internal data structures.
474 ///\todo _heap_map's type could also be in the traits class.
479 for ( NodeIt u(*G) ; u!=INVALID ; ++u ) {
480 _pred->set(u,INVALID);
481 // _predNode->set(u,INVALID);
482 _processed->set(u,false);
483 _heap_map.set(u,Heap::PRE_HEAP);
487 ///Adds a new source node.
489 ///Adds a new source node to the priority heap.
491 ///The optional second parameter is the initial distance of the node.
493 ///It checks if the node has already been added to the heap and
494 ///It is pushed to the heap only if either it was not in the heap
495 ///or the shortest path found till then is longer then \c dst.
496 void addSource(Node s,Value dst=0)
499 if(_heap.state(s) != Heap::IN_HEAP) _heap.push(s,dst);
500 else if(_heap[s]<dst) {
502 _pred->set(s,INVALID);
506 ///Processes the next node in the priority heap
508 ///Processes the next node in the priority heap.
510 ///\warning The priority heap must not be empty!
511 void processNextNode()
514 Value oldvalue=_heap[v];
516 finalizeNodeData(v,oldvalue);
518 for(OutEdgeIt e(*G,v); e!=INVALID; ++e) {
520 switch(_heap.state(w)) {
522 _heap.push(w,oldvalue+(*length)[e]);
524 // _predNode->set(w,v);
527 if ( oldvalue+(*length)[e] < _heap[w] ) {
528 _heap.decrease(w, oldvalue+(*length)[e]);
530 // _predNode->set(w,v);
533 case Heap::POST_HEAP:
539 ///\brief Returns \c false if there are nodes
540 ///to be processed in the priority heap
542 ///Returns \c false if there are nodes
543 ///to be processed in the priority heap
544 bool emptyQueue() { return _heap.empty(); }
545 ///Returns the number of the nodes to be processed in the priority heap
547 ///Returns the number of the nodes to be processed in the priority heap
549 int queueSize() { return _heap.size(); }
551 ///Executes the algorithm.
553 ///Executes the algorithm.
555 ///\pre init() must be called and at least one node should be added
556 ///with addSource() before using this function.
558 ///This method runs the %Dijkstra algorithm from the root node(s)
561 ///shortest path to each node. The algorithm computes
562 ///- The shortest path tree.
563 ///- The distance of each node from the root(s).
567 while ( !_heap.empty() ) processNextNode();
570 ///Executes the algorithm until \c dest is reached.
572 ///Executes the algorithm until \c dest is reached.
574 ///\pre init() must be called and at least one node should be added
575 ///with addSource() before using this function.
577 ///This method runs the %Dijkstra algorithm from the root node(s)
580 ///shortest path to \c dest. The algorithm computes
581 ///- The shortest path to \c dest.
582 ///- The distance of \c dest from the root(s).
584 void start(Node dest)
586 while ( !_heap.empty() && _heap.top()!=dest ) processNextNode();
587 if ( _heap.top()==dest ) finalizeNodeData(_heap.top());
590 ///Executes the algorithm until a condition is met.
592 ///Executes the algorithm until a condition is met.
594 ///\pre init() must be called and at least one node should be added
595 ///with addSource() before using this function.
597 ///\param nm must be a bool (or convertible) node map. The algorithm
598 ///will stop when it reaches a node \c v with <tt>nm[v]==true</tt>.
600 void start(const NM &nm)
602 while ( !_heap.empty() && !nm[_heap.top()] ) processNextNode();
603 if ( !_heap.empty() ) finalizeNodeData(_heap.top());
606 ///Runs %Dijkstra algorithm from node \c s.
608 ///This method runs the %Dijkstra algorithm from a root node \c s
611 ///shortest path to each node. The algorithm computes
612 ///- The shortest path tree.
613 ///- The distance of each node from the root.
615 ///\note d.run(s) is just a shortcut of the following code.
627 ///Finds the shortest path between \c s and \c t.
629 ///Finds the shortest path between \c s and \c t.
631 ///\return The length of the shortest s---t path if there exists one,
633 ///\note Apart from the return value, d.run(s) is
634 ///just a shortcut of the following code.
640 Value run(Node s,Node t) {
644 return (*_pred)[t]==INVALID?0:(*_dist)[t];
649 ///\name Query Functions
650 ///The result of the %Dijkstra algorithm can be obtained using these
652 ///Before the use of these functions,
653 ///either run() or start() must be called.
657 ///The distance of a node from the root.
659 ///Returns the distance of a node from the root.
660 ///\pre \ref run() must be called before using this function.
661 ///\warning If node \c v in unreachable from the root the return value
662 ///of this funcion is undefined.
663 Value dist(Node v) const { return (*_dist)[v]; }
665 ///Returns the 'previous edge' of the shortest path tree.
667 ///For a node \c v it returns the 'previous edge' of the shortest path tree,
668 ///i.e. it returns the last edge of a shortest path from the root to \c
669 ///v. It is \ref INVALID
670 ///if \c v is unreachable from the root or if \c v=s. The
671 ///shortest path tree used here is equal to the shortest path tree used in
672 ///\ref predNode(Node v). \pre \ref run() must be called before using
674 ///\todo predEdge could be a better name.
675 Edge pred(Node v) const { return (*_pred)[v]; }
677 ///Returns the 'previous node' of the shortest path tree.
679 ///For a node \c v it returns the 'previous node' of the shortest path tree,
680 ///i.e. it returns the last but one node from a shortest path from the
681 ///root to \c /v. It is INVALID if \c v is unreachable from the root or if
682 ///\c v=s. The shortest path tree used here is equal to the shortest path
683 ///tree used in \ref pred(Node v). \pre \ref run() must be called before
684 ///using this function.
685 Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:
686 G->source((*_pred)[v]); }
688 ///Returns a reference to the NodeMap of distances.
690 ///Returns a reference to the NodeMap of distances. \pre \ref run() must
691 ///be called before using this function.
692 const DistMap &distMap() const { return *_dist;}
694 ///Returns a reference to the shortest path tree map.
696 ///Returns a reference to the NodeMap of the edges of the
697 ///shortest path tree.
698 ///\pre \ref run() must be called before using this function.
699 const PredMap &predMap() const { return *_pred;}
701 // ///Returns a reference to the map of nodes of shortest paths.
703 // ///Returns a reference to the NodeMap of the last but one nodes of the
704 // ///shortest path tree.
705 // ///\pre \ref run() must be called before using this function.
706 // const PredNodeMap &predNodeMap() const { return *_predNode;}
708 ///Checks if a node is reachable from the root.
710 ///Returns \c true if \c v is reachable from the root.
711 ///\warning The source nodes are inditated as unreached.
712 ///\pre \ref run() must be called before using this function.
714 bool reached(Node v) { return _heap_map[v]!=Heap::PRE_HEAP; }
723 ///Default traits class of Dijkstra function.
725 ///Default traits class of Dijkstra function.
726 ///\param GR Graph type.
727 ///\param LM Type of length map.
728 template<class GR, class LM>
729 struct DijkstraWizardDefaultTraits
731 ///The graph type the algorithm runs on.
733 ///The type of the map that stores the edge lengths.
735 ///The type of the map that stores the edge lengths.
736 ///It must meet the \ref concept::ReadMap "ReadMap" concept.
737 typedef LM LengthMap;
738 //The type of the length of the edges.
739 typedef typename LM::Value Value;
740 ///The heap type used by Dijkstra algorithm.
742 ///The heap type used by Dijkstra algorithm.
746 typedef BinHeap<typename Graph::Node,
748 typename GR::template NodeMap<int>,
749 std::less<Value> > Heap;
751 ///\brief The type of the map that stores the last
752 ///edges of the shortest paths.
754 ///The type of the map that stores the last
755 ///edges of the shortest paths.
756 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
758 typedef NullMap <typename GR::Node,typename GR::Edge> PredMap;
759 ///Instantiates a PredMap.
761 ///This function instantiates a \ref PredMap.
762 ///\param G is the graph, to which we would like to define the PredMap.
763 ///\todo The graph alone may be insufficient for the initialization
764 static PredMap *createPredMap(const GR &G)
766 return new PredMap();
768 ///The type of the map that stores whether a nodes is processed.
770 ///The type of the map that stores whether a nodes is processed.
771 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
772 ///By default it is a NullMap.
773 ///\todo If it is set to a real map,
774 ///Dijkstra::processed() should read this.
775 ///\todo named parameter to set this type, function to read and write.
776 typedef NullMap<typename Graph::Node,bool> ProcessedMap;
777 ///Instantiates a ProcessedMap.
779 ///This function instantiates a \ref ProcessedMap.
780 ///\param G is the graph, to which
781 ///we would like to define the \ref ProcessedMap
782 static ProcessedMap *createProcessedMap(const GR &G)
784 return new ProcessedMap();
786 ///The type of the map that stores the dists of the nodes.
788 ///The type of the map that stores the dists of the nodes.
789 ///It must meet the \ref concept::WriteMap "WriteMap" concept.
791 typedef NullMap<typename Graph::Node,typename LM::Value> DistMap;
792 ///Instantiates a DistMap.
794 ///This function instantiates a \ref DistMap.
795 ///\param G is the graph, to which we would like to define the \ref DistMap
796 static DistMap *createDistMap(const GR &G)
798 return new DistMap();
802 /// Default traits used by \ref DijkstraWizard
804 /// To make it easier to use Dijkstra algorithm
805 ///we have created a wizard class.
806 /// This \ref DijkstraWizard class needs default traits,
807 ///as well as the \ref Dijkstra class.
808 /// The \ref DijkstraWizardBase is a class to be the default traits of the
809 /// \ref DijkstraWizard class.
810 /// \todo More named parameters are required...
811 template<class GR,class LM>
812 class DijkstraWizardBase : public DijkstraWizardDefaultTraits<GR,LM>
815 typedef DijkstraWizardDefaultTraits<GR,LM> Base;
817 /// Type of the nodes in the graph.
818 typedef typename Base::Graph::Node Node;
820 /// Pointer to the underlying graph.
822 /// Pointer to the length map
824 ///Pointer to the map of predecessors edges.
826 // ///Pointer to the map of predecessors nodes.
828 ///Pointer to the map of distances.
830 ///Pointer to the source node.
836 /// This constructor does not require parameters, therefore it initiates
837 /// all of the attributes to default values (0, INVALID).
838 DijkstraWizardBase() : _g(0), _length(0), _pred(0),
840 _dist(0), _source(INVALID) {}
844 /// This constructor requires some parameters,
845 /// listed in the parameters list.
846 /// Others are initiated to 0.
847 /// \param g is the initial value of \ref _g
848 /// \param l is the initial value of \ref _length
849 /// \param s is the initial value of \ref _source
850 DijkstraWizardBase(const GR &g,const LM &l, Node s=INVALID) :
851 _g((void *)&g), _length((void *)&l), _pred(0),
853 _dist(0), _source(s) {}
857 /// A class to make easier the usage of Dijkstra algorithm
859 /// This class is created to make it easier to use Dijkstra algorithm.
860 /// It uses the functions and features of the plain \ref Dijkstra,
861 /// but it is much simpler to use it.
863 /// Simplicity means that the way to change the types defined
864 /// in the traits class is based on functions that returns the new class
865 /// and not on templatable built-in classes.
866 /// When using the plain \ref Dijkstra
867 /// the new class with the modified type comes from
868 /// the original class by using the ::
869 /// operator. In the case of \ref DijkstraWizard only
870 /// a function have to be called and it will
871 /// return the needed class.
873 /// It does not have own \ref run method. When its \ref run method is called
874 /// it initiates a plain \ref Dijkstra class, and calls the \ref Dijkstra::run
877 class DijkstraWizard : public TR
881 ///The type of the underlying graph.
882 typedef typename TR::Graph Graph;
884 typedef typename Graph::Node Node;
886 typedef typename Graph::NodeIt NodeIt;
888 typedef typename Graph::Edge Edge;
890 typedef typename Graph::OutEdgeIt OutEdgeIt;
892 ///The type of the map that stores the edge lengths.
893 typedef typename TR::LengthMap LengthMap;
894 ///The type of the length of the edges.
895 typedef typename LengthMap::Value Value;
896 ///\brief The type of the map that stores the last
897 ///edges of the shortest paths.
898 typedef typename TR::PredMap PredMap;
899 // ///\brief The type of the map that stores the last but one
900 // ///nodes of the shortest paths.
901 // typedef typename TR::PredNodeMap PredNodeMap;
902 ///The type of the map that stores the dists of the nodes.
903 typedef typename TR::DistMap DistMap;
905 ///The heap type used by the dijkstra algorithm.
906 typedef typename TR::Heap Heap;
909 DijkstraWizard() : TR() {}
911 /// Constructor that requires parameters.
913 /// Constructor that requires parameters.
914 /// These parameters will be the default values for the traits class.
915 DijkstraWizard(const Graph &g,const LengthMap &l, Node s=INVALID) :
919 DijkstraWizard(const TR &b) : TR(b) {}
923 ///Runs Dijkstra algorithm from a given node.
925 ///Runs Dijkstra algorithm from a given node.
926 ///The node can be given by the \ref source function.
929 if(Base::_source==INVALID) throw UninitializedParameter();
930 Dijkstra<Graph,LengthMap,TR>
931 Dij(*(Graph*)Base::_g,*(LengthMap*)Base::_length);
932 if(Base::_pred) Dij.predMap(*(PredMap*)Base::_pred);
933 // if(Base::_predNode) Dij.predNodeMap(*(PredNodeMap*)Base::_predNode);
934 if(Base::_dist) Dij.distMap(*(DistMap*)Base::_dist);
935 Dij.run(Base::_source);
938 ///Runs Dijkstra algorithm from the given node.
940 ///Runs Dijkstra algorithm from the given node.
941 ///\param s is the given source.
949 struct DefPredMapBase : public Base {
951 static PredMap *createPredMap(const Graph &G) { return 0; };
952 DefPredMapBase(const Base &b) : Base(b) {}
955 ///\brief \ref named-templ-param "Named parameter"
956 ///function for setting PredMap type
958 /// \ref named-templ-param "Named parameter"
959 ///function for setting PredMap type
962 DijkstraWizard<DefPredMapBase<T> > predMap(const T &t)
964 Base::_pred=(void *)&t;
965 return DijkstraWizard<DefPredMapBase<T> >(*this);
970 // struct DefPredNodeMapBase : public Base {
971 // typedef T PredNodeMap;
972 // static PredNodeMap *createPredNodeMap(const Graph &G) { return 0; };
973 // DefPredNodeMapBase(const Base &b) : Base(b) {}
976 // ///\brief \ref named-templ-param "Named parameter"
977 // ///function for setting PredNodeMap type
979 // /// \ref named-templ-param "Named parameter"
980 // ///function for setting PredNodeMap type
983 // DijkstraWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t)
985 // Base::_predNode=(void *)&t;
986 // return DijkstraWizard<DefPredNodeMapBase<T> >(*this);
990 struct DefDistMapBase : public Base {
992 static DistMap *createDistMap(const Graph &G) { return 0; };
993 DefDistMapBase(const Base &b) : Base(b) {}
996 ///\brief \ref named-templ-param "Named parameter"
997 ///function for setting DistMap type
999 /// \ref named-templ-param "Named parameter"
1000 ///function for setting DistMap type
1003 DijkstraWizard<DefDistMapBase<T> > distMap(const T &t)
1005 Base::_dist=(void *)&t;
1006 return DijkstraWizard<DefDistMapBase<T> >(*this);
1009 /// Sets the source node, from which the Dijkstra algorithm runs.
1011 /// Sets the source node, from which the Dijkstra algorithm runs.
1012 /// \param s is the source node.
1013 DijkstraWizard<TR> &source(Node s)
1021 ///Function type interface for Dijkstra algorithm.
1023 /// \ingroup flowalgs
1024 ///Function type interface for Dijkstra algorithm.
1026 ///This function also has several
1027 ///\ref named-templ-func-param "named parameters",
1028 ///they are declared as the members of class \ref DijkstraWizard.
1030 ///example shows how to use these parameters.
1032 /// dijkstra(g,length,source).predMap(preds).run();
1034 ///\warning Don't forget to put the \ref DijkstraWizard::run() "run()"
1035 ///to the end of the parameter list.
1036 ///\sa DijkstraWizard
1038 template<class GR, class LM>
1039 DijkstraWizard<DijkstraWizardBase<GR,LM> >
1040 dijkstra(const GR &g,const LM &l,typename GR::Node s=INVALID)
1042 return DijkstraWizard<DijkstraWizardBase<GR,LM> >(g,l,s);
1045 } //END OF NAMESPACE LEMON