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