[906] | 1 | /* -*- C++ -*- |
---|
[921] | 2 | * src/lemon/dfs.h - Part of LEMON, a generic C++ optimization library |
---|
[906] | 3 | * |
---|
[1164] | 4 | * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport |
---|
[906] | 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 | |
---|
[921] | 17 | #ifndef LEMON_DFS_H |
---|
| 18 | #define LEMON_DFS_H |
---|
[780] | 19 | |
---|
| 20 | ///\ingroup flowalgs |
---|
| 21 | ///\file |
---|
[1218] | 22 | ///\brief Dfs algorithm. |
---|
[780] | 23 | |
---|
[1218] | 24 | #include <lemon/list_graph.h> |
---|
[946] | 25 | #include <lemon/graph_utils.h> |
---|
[921] | 26 | #include <lemon/invalid.h> |
---|
[1218] | 27 | #include <lemon/error.h> |
---|
| 28 | #include <lemon/maps.h> |
---|
[780] | 29 | |
---|
[921] | 30 | namespace lemon { |
---|
[780] | 31 | |
---|
| 32 | |
---|
[1218] | 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 | |
---|
[781] | 124 | ///%DFS algorithm class. |
---|
[1218] | 125 | |
---|
| 126 | ///\ingroup flowalgs |
---|
| 127 | ///This class provides an efficient implementation of the %DFS algorithm. |
---|
[780] | 128 | /// |
---|
[1218] | 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. |
---|
[780] | 137 | /// |
---|
[1218] | 138 | ///\author Jacint Szabo and Alpar Juttner |
---|
| 139 | ///\todo A compare object would be nice. |
---|
[780] | 140 | |
---|
| 141 | #ifdef DOXYGEN |
---|
[1218] | 142 | template <typename GR, |
---|
| 143 | typename TR> |
---|
[780] | 144 | #else |
---|
[1218] | 145 | template <typename GR=ListGraph, |
---|
| 146 | typename TR=DfsDefaultTraits<GR> > |
---|
[780] | 147 | #endif |
---|
[1218] | 148 | class Dfs { |
---|
[780] | 149 | public: |
---|
[1218] | 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; |
---|
[780] | 164 | ///The type of the underlying graph. |
---|
[1218] | 165 | typedef typename TR::Graph Graph; |
---|
[911] | 166 | ///\e |
---|
[780] | 167 | typedef typename Graph::Node Node; |
---|
[911] | 168 | ///\e |
---|
[780] | 169 | typedef typename Graph::NodeIt NodeIt; |
---|
[911] | 170 | ///\e |
---|
[780] | 171 | typedef typename Graph::Edge Edge; |
---|
[911] | 172 | ///\e |
---|
[780] | 173 | typedef typename Graph::OutEdgeIt OutEdgeIt; |
---|
| 174 | |
---|
| 175 | ///\brief The type of the map that stores the last |
---|
[1218] | 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; |
---|
[780] | 187 | private: |
---|
[802] | 188 | /// Pointer to the underlying graph. |
---|
[780] | 189 | const Graph *G; |
---|
[802] | 190 | ///Pointer to the map of predecessors edges. |
---|
[1218] | 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; |
---|
[802] | 198 | ///Pointer to the map of distances. |
---|
[1218] | 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; |
---|
[780] | 210 | |
---|
[1218] | 211 | std::vector<typename Graph::OutEdgeIt> _stack; |
---|
| 212 | int _stack_head; |
---|
| 213 | // ///The source node of the last execution. |
---|
| 214 | // Node source; |
---|
[780] | 215 | |
---|
[1218] | 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() |
---|
[780] | 221 | { |
---|
[1218] | 222 | if(!_pred) { |
---|
| 223 | local_pred = true; |
---|
| 224 | _pred = Traits::createPredMap(*G); |
---|
[780] | 225 | } |
---|
[1218] | 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); |
---|
[780] | 233 | } |
---|
[1218] | 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); |
---|
[780] | 241 | } |
---|
| 242 | } |
---|
| 243 | |
---|
[1218] | 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 | |
---|
[802] | 360 | ///Constructor. |
---|
| 361 | |
---|
| 362 | ///\param _G the graph the algorithm will run on. |
---|
[911] | 363 | /// |
---|
[780] | 364 | Dfs(const Graph& _G) : |
---|
| 365 | G(&_G), |
---|
[1218] | 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) |
---|
[780] | 371 | { } |
---|
| 372 | |
---|
[802] | 373 | ///Destructor. |
---|
[780] | 374 | ~Dfs() |
---|
| 375 | { |
---|
[1218] | 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; |
---|
[780] | 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> |
---|
[1218] | 390 | Dfs &predMap(PredMap &m) |
---|
[780] | 391 | { |
---|
[1218] | 392 | if(local_pred) { |
---|
| 393 | delete _pred; |
---|
| 394 | local_pred=false; |
---|
[780] | 395 | } |
---|
[1218] | 396 | _pred = &m; |
---|
[780] | 397 | return *this; |
---|
| 398 | } |
---|
| 399 | |
---|
[1218] | 400 | // ///Sets the map storing the predecessor nodes. |
---|
[780] | 401 | |
---|
[1218] | 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 | // } |
---|
[780] | 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> |
---|
[1218] | 424 | Dfs &distMap(DistMap &m) |
---|
[780] | 425 | { |
---|
[1218] | 426 | if(local_dist) { |
---|
| 427 | delete _dist; |
---|
| 428 | local_dist=false; |
---|
[780] | 429 | } |
---|
[1218] | 430 | _dist = &m; |
---|
[780] | 431 | return *this; |
---|
| 432 | } |
---|
| 433 | |
---|
[1220] | 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 | |
---|
[1218] | 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; |
---|
[780] | 490 | for ( NodeIt u(*G) ; u!=INVALID ; ++u ) { |
---|
[1218] | 491 | _pred->set(u,INVALID); |
---|
| 492 | // _predNode->set(u,INVALID); |
---|
| 493 | _reached->set(u,false); |
---|
| 494 | _processed->set(u,false); |
---|
[780] | 495 | } |
---|
| 496 | } |
---|
| 497 | |
---|
[1218] | 498 | ///Adds a new source node. |
---|
[780] | 499 | |
---|
[1218] | 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)); |
---|
[1233] | 528 | ++_stack_head; |
---|
| 529 | _stack[_stack_head] = OutEdgeIt(*G, m); |
---|
[1218] | 530 | _dist->set(m,_stack_head); |
---|
| 531 | } |
---|
| 532 | else { |
---|
| 533 | Node n; |
---|
| 534 | while(_stack_head>=0 && |
---|
| 535 | (n=G->source(_stack[_stack_head]), |
---|
| 536 | ++_stack[_stack_head]==INVALID)) |
---|
| 537 | { |
---|
| 538 | _processed->set(n,true); |
---|
| 539 | --_stack_head; |
---|
| 540 | } |
---|
| 541 | } |
---|
| 542 | } |
---|
| 543 | |
---|
| 544 | ///\brief Returns \c false if there are nodes |
---|
| 545 | ///to be processed in the queue |
---|
| 546 | /// |
---|
| 547 | ///Returns \c false if there are nodes |
---|
| 548 | ///to be processed in the queue |
---|
| 549 | bool emptyQueue() { return _stack_head<0; } |
---|
| 550 | ///Returns the number of the nodes to be processed. |
---|
| 551 | |
---|
| 552 | ///Returns the number of the nodes to be processed in the queue. |
---|
| 553 | /// |
---|
| 554 | int queueSize() { return _stack_head+1; } |
---|
| 555 | |
---|
| 556 | ///Executes the algorithm. |
---|
| 557 | |
---|
| 558 | ///Executes the algorithm. |
---|
| 559 | /// |
---|
| 560 | ///\pre init() must be called and at least one node should be added |
---|
| 561 | ///with addSource() before using this function. |
---|
| 562 | /// |
---|
| 563 | ///This method runs the %DFS algorithm from the root node(s) |
---|
| 564 | ///in order to |
---|
| 565 | ///compute the |
---|
| 566 | ///%DFS path to each node. The algorithm computes |
---|
| 567 | ///- The %DFS tree. |
---|
| 568 | ///- The distance of each node from the root(s). |
---|
| 569 | /// |
---|
| 570 | void start() |
---|
| 571 | { |
---|
| 572 | while ( !emptyQueue() ) processNextEdge(); |
---|
| 573 | } |
---|
| 574 | |
---|
| 575 | ///Executes the algorithm until \c dest is reached. |
---|
| 576 | |
---|
| 577 | ///Executes the algorithm until \c dest is reached. |
---|
| 578 | /// |
---|
| 579 | ///\pre init() must be called and at least one node should be added |
---|
| 580 | ///with addSource() before using this function. |
---|
| 581 | /// |
---|
| 582 | ///This method runs the %DFS algorithm from the root node(s) |
---|
| 583 | ///in order to |
---|
| 584 | ///compute the |
---|
| 585 | ///%DFS path to \c dest. The algorithm computes |
---|
| 586 | ///- The %DFS path to \c dest. |
---|
| 587 | ///- The distance of \c dest from the root(s). |
---|
| 588 | /// |
---|
| 589 | void start(Node dest) |
---|
| 590 | { |
---|
[1233] | 591 | while ( !emptyQueue() && G->target(_stack[_stack_head])!=dest ) |
---|
| 592 | processNextEdge(); |
---|
[1218] | 593 | } |
---|
| 594 | |
---|
| 595 | ///Executes the algorithm until a condition is met. |
---|
| 596 | |
---|
| 597 | ///Executes the algorithm until a condition is met. |
---|
| 598 | /// |
---|
| 599 | ///\pre init() must be called and at least one node should be added |
---|
| 600 | ///with addSource() before using this function. |
---|
| 601 | /// |
---|
[1233] | 602 | ///\param nm must be a bool (or convertible) edge map. The algorithm |
---|
| 603 | ///will stop when it reaches a edge \c v with <tt>nm[v]==true</tt>. |
---|
| 604 | ///\warning Contrary to \ref Dfs and \ref Dijkstra, \c mn is an edge map, |
---|
| 605 | ///not a node map. |
---|
[1218] | 606 | template<class NM> |
---|
| 607 | void start(const NM &nm) |
---|
| 608 | { |
---|
[1233] | 609 | while ( !emptyQueue() && !nm[_stack[_stack_head]] ) processNextEdge(); |
---|
[1218] | 610 | } |
---|
| 611 | |
---|
| 612 | ///Runs %DFS algorithm from node \c s. |
---|
| 613 | |
---|
| 614 | ///This method runs the %DFS algorithm from a root node \c s |
---|
| 615 | ///in order to |
---|
| 616 | ///compute the |
---|
| 617 | ///%DFS path to each node. The algorithm computes |
---|
| 618 | ///- The %DFS tree. |
---|
| 619 | ///- The distance of each node from the root. |
---|
| 620 | /// |
---|
| 621 | ///\note d.run(s) is just a shortcut of the following code. |
---|
| 622 | ///\code |
---|
| 623 | /// d.init(); |
---|
| 624 | /// d.addSource(s); |
---|
| 625 | /// d.start(); |
---|
| 626 | ///\endcode |
---|
| 627 | void run(Node s) { |
---|
| 628 | init(); |
---|
| 629 | addSource(s); |
---|
| 630 | start(); |
---|
| 631 | } |
---|
| 632 | |
---|
| 633 | ///Finds the %DFS path between \c s and \c t. |
---|
| 634 | |
---|
| 635 | ///Finds the %DFS path between \c s and \c t. |
---|
| 636 | /// |
---|
| 637 | ///\return The length of the %DFS s---t path if there exists one, |
---|
| 638 | ///0 otherwise. |
---|
| 639 | ///\note Apart from the return value, d.run(s) is |
---|
| 640 | ///just a shortcut of the following code. |
---|
| 641 | ///\code |
---|
| 642 | /// d.init(); |
---|
| 643 | /// d.addSource(s); |
---|
| 644 | /// d.start(t); |
---|
| 645 | ///\endcode |
---|
| 646 | int run(Node s,Node t) { |
---|
| 647 | init(); |
---|
| 648 | addSource(s); |
---|
| 649 | start(t); |
---|
[1233] | 650 | return reached(t)?_stack_head+1:0; |
---|
[1218] | 651 | } |
---|
| 652 | |
---|
| 653 | ///@} |
---|
| 654 | |
---|
| 655 | ///\name Query Functions |
---|
| 656 | ///The result of the %DFS algorithm can be obtained using these |
---|
| 657 | ///functions.\n |
---|
| 658 | ///Before the use of these functions, |
---|
| 659 | ///either run() or start() must be called. |
---|
| 660 | |
---|
| 661 | ///@{ |
---|
| 662 | |
---|
| 663 | ///The distance of a node from the root(s). |
---|
| 664 | |
---|
| 665 | ///Returns the distance of a node from the root(s). |
---|
[780] | 666 | ///\pre \ref run() must be called before using this function. |
---|
[1218] | 667 | ///\warning If node \c v in unreachable from the root(s) the return value |
---|
[780] | 668 | ///of this funcion is undefined. |
---|
[1218] | 669 | int dist(Node v) const { return (*_dist)[v]; } |
---|
[780] | 670 | |
---|
[1218] | 671 | ///Returns the 'previous edge' of the %DFS tree. |
---|
[780] | 672 | |
---|
[1218] | 673 | ///For a node \c v it returns the 'previous edge' |
---|
| 674 | ///of the %DFS path, |
---|
| 675 | ///i.e. it returns the last edge of a %DFS path from the root(s) to \c |
---|
[780] | 676 | ///v. It is \ref INVALID |
---|
[1218] | 677 | ///if \c v is unreachable from the root(s) or \c v is a root. The |
---|
[781] | 678 | ///%DFS tree used here is equal to the %DFS tree used in |
---|
[1218] | 679 | ///\ref predNode(Node v). |
---|
| 680 | ///\pre Either \ref run() or \ref start() must be called before using |
---|
[780] | 681 | ///this function. |
---|
[1218] | 682 | ///\todo predEdge could be a better name. |
---|
| 683 | Edge pred(Node v) const { return (*_pred)[v];} |
---|
[780] | 684 | |
---|
[781] | 685 | ///Returns the 'previous node' of the %DFS tree. |
---|
[780] | 686 | |
---|
[1218] | 687 | ///For a node \c v it returns the 'previous node' |
---|
| 688 | ///of the %DFS tree, |
---|
| 689 | ///i.e. it returns the last but one node from a %DFS path from the |
---|
| 690 | ///root(a) to \c /v. |
---|
| 691 | ///It is INVALID if \c v is unreachable from the root(s) or |
---|
| 692 | ///if \c v itself a root. |
---|
| 693 | ///The %DFS tree used here is equal to the %DFS |
---|
| 694 | ///tree used in \ref pred(Node v). |
---|
| 695 | ///\pre Either \ref run() or \ref start() must be called before |
---|
[780] | 696 | ///using this function. |
---|
[1218] | 697 | Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID: |
---|
| 698 | G->source((*_pred)[v]); } |
---|
[780] | 699 | |
---|
[1218] | 700 | ///Returns a reference to the NodeMap of distances. |
---|
| 701 | |
---|
| 702 | ///Returns a reference to the NodeMap of distances. |
---|
| 703 | ///\pre Either \ref run() or \ref init() must |
---|
[780] | 704 | ///be called before using this function. |
---|
[1218] | 705 | const DistMap &distMap() const { return *_dist;} |
---|
[780] | 706 | |
---|
[1218] | 707 | ///Returns a reference to the %DFS edge-tree map. |
---|
[780] | 708 | |
---|
| 709 | ///Returns a reference to the NodeMap of the edges of the |
---|
[781] | 710 | ///%DFS tree. |
---|
[1218] | 711 | ///\pre Either \ref run() or \ref init() |
---|
| 712 | ///must be called before using this function. |
---|
| 713 | const PredMap &predMap() const { return *_pred;} |
---|
[780] | 714 | |
---|
[1218] | 715 | // ///Returns a reference to the map of nodes of %DFS paths. |
---|
[780] | 716 | |
---|
[1218] | 717 | // ///Returns a reference to the NodeMap of the last but one nodes of the |
---|
| 718 | // ///%DFS tree. |
---|
| 719 | // ///\pre \ref run() must be called before using this function. |
---|
| 720 | // const PredNodeMap &predNodeMap() const { return *_predNode;} |
---|
[780] | 721 | |
---|
| 722 | ///Checks if a node is reachable from the root. |
---|
| 723 | |
---|
| 724 | ///Returns \c true if \c v is reachable from the root. |
---|
[1218] | 725 | ///\warning The source nodes are inditated as unreached. |
---|
| 726 | ///\pre Either \ref run() or \ref start() |
---|
| 727 | ///must be called before using this function. |
---|
[780] | 728 | /// |
---|
[1218] | 729 | bool reached(Node v) { return (*_reached)[v]; } |
---|
| 730 | |
---|
| 731 | ///@} |
---|
| 732 | }; |
---|
| 733 | |
---|
| 734 | ///Default traits class of Dfs function. |
---|
| 735 | |
---|
| 736 | ///Default traits class of Dfs function. |
---|
| 737 | ///\param GR Graph type. |
---|
| 738 | template<class GR> |
---|
| 739 | struct DfsWizardDefaultTraits |
---|
| 740 | { |
---|
| 741 | ///The graph type the algorithm runs on. |
---|
| 742 | typedef GR Graph; |
---|
| 743 | ///\brief The type of the map that stores the last |
---|
| 744 | ///edges of the %DFS paths. |
---|
| 745 | /// |
---|
| 746 | ///The type of the map that stores the last |
---|
| 747 | ///edges of the %DFS paths. |
---|
| 748 | ///It must meet the \ref concept::WriteMap "WriteMap" concept. |
---|
[780] | 749 | /// |
---|
[1218] | 750 | typedef NullMap<typename Graph::Node,typename GR::Edge> PredMap; |
---|
| 751 | ///Instantiates a PredMap. |
---|
| 752 | |
---|
| 753 | ///This function instantiates a \ref PredMap. |
---|
| 754 | ///\param G is the graph, to which we would like to define the PredMap. |
---|
| 755 | ///\todo The graph alone may be insufficient to initialize |
---|
| 756 | static PredMap *createPredMap(const GR &G) |
---|
| 757 | { |
---|
| 758 | return new PredMap(); |
---|
| 759 | } |
---|
| 760 | // ///\brief The type of the map that stores the last but one |
---|
| 761 | // ///nodes of the %DFS paths. |
---|
| 762 | // /// |
---|
| 763 | // ///The type of the map that stores the last but one |
---|
| 764 | // ///nodes of the %DFS paths. |
---|
| 765 | // ///It must meet the \ref concept::WriteMap "WriteMap" concept. |
---|
| 766 | // /// |
---|
| 767 | // typedef NullMap<typename Graph::Node,typename Graph::Node> PredNodeMap; |
---|
| 768 | // ///Instantiates a PredNodeMap. |
---|
| 769 | |
---|
| 770 | // ///This function instantiates a \ref PredNodeMap. |
---|
| 771 | // ///\param G is the graph, to which |
---|
| 772 | // ///we would like to define the \ref PredNodeMap |
---|
| 773 | // static PredNodeMap *createPredNodeMap(const GR &G) |
---|
| 774 | // { |
---|
| 775 | // return new PredNodeMap(); |
---|
| 776 | // } |
---|
| 777 | |
---|
| 778 | ///The type of the map that indicates which nodes are processed. |
---|
| 779 | |
---|
| 780 | ///The type of the map that indicates which nodes are processed. |
---|
| 781 | ///It must meet the \ref concept::WriteMap "WriteMap" concept. |
---|
| 782 | ///\todo named parameter to set this type, function to read and write. |
---|
| 783 | typedef NullMap<typename Graph::Node,bool> ProcessedMap; |
---|
| 784 | ///Instantiates a ProcessedMap. |
---|
| 785 | |
---|
| 786 | ///This function instantiates a \ref ProcessedMap. |
---|
| 787 | ///\param G is the graph, to which |
---|
| 788 | ///we would like to define the \ref ProcessedMap |
---|
| 789 | static ProcessedMap *createProcessedMap(const GR &G) |
---|
| 790 | { |
---|
| 791 | return new ProcessedMap(); |
---|
| 792 | } |
---|
| 793 | ///The type of the map that indicates which nodes are reached. |
---|
| 794 | |
---|
| 795 | ///The type of the map that indicates which nodes are reached. |
---|
| 796 | ///It must meet the \ref concept::WriteMap "WriteMap" concept. |
---|
| 797 | ///\todo named parameter to set this type, function to read and write. |
---|
| 798 | typedef typename Graph::template NodeMap<bool> ReachedMap; |
---|
| 799 | ///Instantiates a ReachedMap. |
---|
| 800 | |
---|
| 801 | ///This function instantiates a \ref ReachedMap. |
---|
| 802 | ///\param G is the graph, to which |
---|
| 803 | ///we would like to define the \ref ReachedMap. |
---|
| 804 | static ReachedMap *createReachedMap(const GR &G) |
---|
| 805 | { |
---|
| 806 | return new ReachedMap(G); |
---|
| 807 | } |
---|
| 808 | ///The type of the map that stores the dists of the nodes. |
---|
| 809 | |
---|
| 810 | ///The type of the map that stores the dists of the nodes. |
---|
| 811 | ///It must meet the \ref concept::WriteMap "WriteMap" concept. |
---|
| 812 | /// |
---|
| 813 | typedef NullMap<typename Graph::Node,int> DistMap; |
---|
| 814 | ///Instantiates a DistMap. |
---|
| 815 | |
---|
| 816 | ///This function instantiates a \ref DistMap. |
---|
| 817 | ///\param G is the graph, to which we would like to define the \ref DistMap |
---|
| 818 | static DistMap *createDistMap(const GR &G) |
---|
| 819 | { |
---|
| 820 | return new DistMap(); |
---|
| 821 | } |
---|
| 822 | }; |
---|
| 823 | |
---|
| 824 | /// Default traits used by \ref DfsWizard |
---|
| 825 | |
---|
| 826 | /// To make it easier to use Dfs algorithm |
---|
| 827 | ///we have created a wizard class. |
---|
| 828 | /// This \ref DfsWizard class needs default traits, |
---|
| 829 | ///as well as the \ref Dfs class. |
---|
| 830 | /// The \ref DfsWizardBase is a class to be the default traits of the |
---|
| 831 | /// \ref DfsWizard class. |
---|
| 832 | template<class GR> |
---|
| 833 | class DfsWizardBase : public DfsWizardDefaultTraits<GR> |
---|
| 834 | { |
---|
| 835 | |
---|
| 836 | typedef DfsWizardDefaultTraits<GR> Base; |
---|
| 837 | protected: |
---|
| 838 | /// Type of the nodes in the graph. |
---|
| 839 | typedef typename Base::Graph::Node Node; |
---|
| 840 | |
---|
| 841 | /// Pointer to the underlying graph. |
---|
| 842 | void *_g; |
---|
| 843 | ///Pointer to the map of reached nodes. |
---|
| 844 | void *_reached; |
---|
| 845 | ///Pointer to the map of processed nodes. |
---|
| 846 | void *_processed; |
---|
| 847 | ///Pointer to the map of predecessors edges. |
---|
| 848 | void *_pred; |
---|
| 849 | // ///Pointer to the map of predecessors nodes. |
---|
| 850 | // void *_predNode; |
---|
| 851 | ///Pointer to the map of distances. |
---|
| 852 | void *_dist; |
---|
| 853 | ///Pointer to the source node. |
---|
| 854 | Node _source; |
---|
| 855 | |
---|
| 856 | public: |
---|
| 857 | /// Constructor. |
---|
| 858 | |
---|
| 859 | /// This constructor does not require parameters, therefore it initiates |
---|
| 860 | /// all of the attributes to default values (0, INVALID). |
---|
| 861 | DfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0), |
---|
| 862 | // _predNode(0), |
---|
| 863 | _dist(0), _source(INVALID) {} |
---|
| 864 | |
---|
| 865 | /// Constructor. |
---|
| 866 | |
---|
| 867 | /// This constructor requires some parameters, |
---|
| 868 | /// listed in the parameters list. |
---|
| 869 | /// Others are initiated to 0. |
---|
| 870 | /// \param g is the initial value of \ref _g |
---|
| 871 | /// \param s is the initial value of \ref _source |
---|
| 872 | DfsWizardBase(const GR &g, Node s=INVALID) : |
---|
| 873 | _g((void *)&g), _reached(0), _processed(0), _pred(0), |
---|
| 874 | // _predNode(0), |
---|
| 875 | _dist(0), _source(s) {} |
---|
| 876 | |
---|
| 877 | }; |
---|
| 878 | |
---|
| 879 | /// A class to make the usage of Dfs algorithm easier |
---|
| 880 | |
---|
| 881 | /// This class is created to make it easier to use Dfs algorithm. |
---|
| 882 | /// It uses the functions and features of the plain \ref Dfs, |
---|
| 883 | /// but it is much simpler to use it. |
---|
| 884 | /// |
---|
| 885 | /// Simplicity means that the way to change the types defined |
---|
| 886 | /// in the traits class is based on functions that returns the new class |
---|
| 887 | /// and not on templatable built-in classes. |
---|
| 888 | /// When using the plain \ref Dfs |
---|
| 889 | /// the new class with the modified type comes from |
---|
| 890 | /// the original class by using the :: |
---|
| 891 | /// operator. In the case of \ref DfsWizard only |
---|
| 892 | /// a function have to be called and it will |
---|
| 893 | /// return the needed class. |
---|
| 894 | /// |
---|
| 895 | /// It does not have own \ref run method. When its \ref run method is called |
---|
| 896 | /// it initiates a plain \ref Dfs class, and calls the \ref Dfs::run |
---|
| 897 | /// method of it. |
---|
| 898 | template<class TR> |
---|
| 899 | class DfsWizard : public TR |
---|
| 900 | { |
---|
| 901 | typedef TR Base; |
---|
| 902 | |
---|
| 903 | ///The type of the underlying graph. |
---|
| 904 | typedef typename TR::Graph Graph; |
---|
| 905 | //\e |
---|
| 906 | typedef typename Graph::Node Node; |
---|
| 907 | //\e |
---|
| 908 | typedef typename Graph::NodeIt NodeIt; |
---|
| 909 | //\e |
---|
| 910 | typedef typename Graph::Edge Edge; |
---|
| 911 | //\e |
---|
| 912 | typedef typename Graph::OutEdgeIt OutEdgeIt; |
---|
| 913 | |
---|
| 914 | ///\brief The type of the map that stores |
---|
| 915 | ///the reached nodes |
---|
| 916 | typedef typename TR::ReachedMap ReachedMap; |
---|
| 917 | ///\brief The type of the map that stores |
---|
| 918 | ///the processed nodes |
---|
| 919 | typedef typename TR::ProcessedMap ProcessedMap; |
---|
| 920 | ///\brief The type of the map that stores the last |
---|
| 921 | ///edges of the %DFS paths. |
---|
| 922 | typedef typename TR::PredMap PredMap; |
---|
| 923 | // ///\brief The type of the map that stores the last but one |
---|
| 924 | // ///nodes of the %DFS paths. |
---|
| 925 | // typedef typename TR::PredNodeMap PredNodeMap; |
---|
| 926 | ///The type of the map that stores the dists of the nodes. |
---|
| 927 | typedef typename TR::DistMap DistMap; |
---|
| 928 | |
---|
| 929 | public: |
---|
| 930 | /// Constructor. |
---|
| 931 | DfsWizard() : TR() {} |
---|
| 932 | |
---|
| 933 | /// Constructor that requires parameters. |
---|
| 934 | |
---|
| 935 | /// Constructor that requires parameters. |
---|
| 936 | /// These parameters will be the default values for the traits class. |
---|
| 937 | DfsWizard(const Graph &g, Node s=INVALID) : |
---|
| 938 | TR(g,s) {} |
---|
| 939 | |
---|
| 940 | ///Copy constructor |
---|
| 941 | DfsWizard(const TR &b) : TR(b) {} |
---|
| 942 | |
---|
| 943 | ~DfsWizard() {} |
---|
| 944 | |
---|
| 945 | ///Runs Dfs algorithm from a given node. |
---|
| 946 | |
---|
| 947 | ///Runs Dfs algorithm from a given node. |
---|
| 948 | ///The node can be given by the \ref source function. |
---|
| 949 | void run() |
---|
| 950 | { |
---|
| 951 | if(Base::_source==INVALID) throw UninitializedParameter(); |
---|
| 952 | Dfs<Graph,TR> alg(*(Graph*)Base::_g); |
---|
| 953 | if(Base::_reached) alg.reachedMap(*(ReachedMap*)Base::_reached); |
---|
| 954 | if(Base::_processed) alg.processedMap(*(ProcessedMap*)Base::_processed); |
---|
| 955 | if(Base::_pred) alg.predMap(*(PredMap*)Base::_pred); |
---|
| 956 | // if(Base::_predNode) alg.predNodeMap(*(PredNodeMap*)Base::_predNode); |
---|
| 957 | if(Base::_dist) alg.distMap(*(DistMap*)Base::_dist); |
---|
| 958 | alg.run(Base::_source); |
---|
| 959 | } |
---|
| 960 | |
---|
| 961 | ///Runs Dfs algorithm from the given node. |
---|
| 962 | |
---|
| 963 | ///Runs Dfs algorithm from the given node. |
---|
| 964 | ///\param s is the given source. |
---|
| 965 | void run(Node s) |
---|
| 966 | { |
---|
| 967 | Base::_source=s; |
---|
| 968 | run(); |
---|
| 969 | } |
---|
| 970 | |
---|
| 971 | template<class T> |
---|
| 972 | struct DefPredMapBase : public Base { |
---|
| 973 | typedef T PredMap; |
---|
| 974 | static PredMap *createPredMap(const Graph &G) { return 0; }; |
---|
[1236] | 975 | DefPredMapBase(const TR &b) : TR(b) {} |
---|
[1218] | 976 | }; |
---|
| 977 | |
---|
| 978 | ///\brief \ref named-templ-param "Named parameter" |
---|
| 979 | ///function for setting PredMap type |
---|
| 980 | /// |
---|
| 981 | /// \ref named-templ-param "Named parameter" |
---|
| 982 | ///function for setting PredMap type |
---|
| 983 | /// |
---|
| 984 | template<class T> |
---|
| 985 | DfsWizard<DefPredMapBase<T> > predMap(const T &t) |
---|
| 986 | { |
---|
| 987 | Base::_pred=(void *)&t; |
---|
| 988 | return DfsWizard<DefPredMapBase<T> >(*this); |
---|
| 989 | } |
---|
| 990 | |
---|
| 991 | |
---|
| 992 | template<class T> |
---|
| 993 | struct DefReachedMapBase : public Base { |
---|
| 994 | typedef T ReachedMap; |
---|
| 995 | static ReachedMap *createReachedMap(const Graph &G) { return 0; }; |
---|
[1236] | 996 | DefReachedMapBase(const TR &b) : TR(b) {} |
---|
[1218] | 997 | }; |
---|
| 998 | |
---|
| 999 | ///\brief \ref named-templ-param "Named parameter" |
---|
| 1000 | ///function for setting ReachedMap |
---|
| 1001 | /// |
---|
| 1002 | /// \ref named-templ-param "Named parameter" |
---|
| 1003 | ///function for setting ReachedMap |
---|
| 1004 | /// |
---|
| 1005 | template<class T> |
---|
| 1006 | DfsWizard<DefReachedMapBase<T> > reachedMap(const T &t) |
---|
| 1007 | { |
---|
| 1008 | Base::_pred=(void *)&t; |
---|
| 1009 | return DfsWizard<DefReachedMapBase<T> >(*this); |
---|
| 1010 | } |
---|
| 1011 | |
---|
| 1012 | |
---|
| 1013 | template<class T> |
---|
| 1014 | struct DefProcessedMapBase : public Base { |
---|
| 1015 | typedef T ProcessedMap; |
---|
| 1016 | static ProcessedMap *createProcessedMap(const Graph &G) { return 0; }; |
---|
[1236] | 1017 | DefProcessedMapBase(const TR &b) : TR(b) {} |
---|
[1218] | 1018 | }; |
---|
| 1019 | |
---|
| 1020 | ///\brief \ref named-templ-param "Named parameter" |
---|
| 1021 | ///function for setting ProcessedMap |
---|
| 1022 | /// |
---|
| 1023 | /// \ref named-templ-param "Named parameter" |
---|
| 1024 | ///function for setting ProcessedMap |
---|
| 1025 | /// |
---|
| 1026 | template<class T> |
---|
| 1027 | DfsWizard<DefProcessedMapBase<T> > processedMap(const T &t) |
---|
| 1028 | { |
---|
| 1029 | Base::_pred=(void *)&t; |
---|
| 1030 | return DfsWizard<DefProcessedMapBase<T> >(*this); |
---|
| 1031 | } |
---|
| 1032 | |
---|
| 1033 | |
---|
| 1034 | // template<class T> |
---|
| 1035 | // struct DefPredNodeMapBase : public Base { |
---|
| 1036 | // typedef T PredNodeMap; |
---|
| 1037 | // static PredNodeMap *createPredNodeMap(const Graph &G) { return 0; }; |
---|
[1236] | 1038 | // DefPredNodeMapBase(const TR &b) : TR(b) {} |
---|
[1218] | 1039 | // }; |
---|
| 1040 | |
---|
| 1041 | // ///\brief \ref named-templ-param "Named parameter" |
---|
| 1042 | // ///function for setting PredNodeMap type |
---|
| 1043 | // /// |
---|
| 1044 | // /// \ref named-templ-param "Named parameter" |
---|
| 1045 | // ///function for setting PredNodeMap type |
---|
| 1046 | // /// |
---|
| 1047 | // template<class T> |
---|
| 1048 | // DfsWizard<DefPredNodeMapBase<T> > predNodeMap(const T &t) |
---|
| 1049 | // { |
---|
| 1050 | // Base::_predNode=(void *)&t; |
---|
| 1051 | // return DfsWizard<DefPredNodeMapBase<T> >(*this); |
---|
| 1052 | // } |
---|
| 1053 | |
---|
| 1054 | template<class T> |
---|
| 1055 | struct DefDistMapBase : public Base { |
---|
| 1056 | typedef T DistMap; |
---|
| 1057 | static DistMap *createDistMap(const Graph &G) { return 0; }; |
---|
[1236] | 1058 | DefDistMapBase(const TR &b) : TR(b) {} |
---|
[1218] | 1059 | }; |
---|
| 1060 | |
---|
| 1061 | ///\brief \ref named-templ-param "Named parameter" |
---|
| 1062 | ///function for setting DistMap type |
---|
| 1063 | /// |
---|
| 1064 | /// \ref named-templ-param "Named parameter" |
---|
| 1065 | ///function for setting DistMap type |
---|
| 1066 | /// |
---|
| 1067 | template<class T> |
---|
| 1068 | DfsWizard<DefDistMapBase<T> > distMap(const T &t) |
---|
| 1069 | { |
---|
| 1070 | Base::_dist=(void *)&t; |
---|
| 1071 | return DfsWizard<DefDistMapBase<T> >(*this); |
---|
| 1072 | } |
---|
| 1073 | |
---|
| 1074 | /// Sets the source node, from which the Dfs algorithm runs. |
---|
| 1075 | |
---|
| 1076 | /// Sets the source node, from which the Dfs algorithm runs. |
---|
| 1077 | /// \param s is the source node. |
---|
| 1078 | DfsWizard<TR> &source(Node s) |
---|
| 1079 | { |
---|
| 1080 | Base::_source=s; |
---|
| 1081 | return *this; |
---|
| 1082 | } |
---|
[780] | 1083 | |
---|
| 1084 | }; |
---|
| 1085 | |
---|
[1218] | 1086 | ///Function type interface for Dfs algorithm. |
---|
| 1087 | |
---|
| 1088 | /// \ingroup flowalgs |
---|
| 1089 | ///Function type interface for Dfs algorithm. |
---|
| 1090 | /// |
---|
| 1091 | ///This function also has several |
---|
| 1092 | ///\ref named-templ-func-param "named parameters", |
---|
| 1093 | ///they are declared as the members of class \ref DfsWizard. |
---|
| 1094 | ///The following |
---|
| 1095 | ///example shows how to use these parameters. |
---|
| 1096 | ///\code |
---|
| 1097 | /// dfs(g,source).predMap(preds).run(); |
---|
| 1098 | ///\endcode |
---|
| 1099 | ///\warning Don't forget to put the \ref DfsWizard::run() "run()" |
---|
| 1100 | ///to the end of the parameter list. |
---|
| 1101 | ///\sa DfsWizard |
---|
| 1102 | ///\sa Dfs |
---|
| 1103 | template<class GR> |
---|
| 1104 | DfsWizard<DfsWizardBase<GR> > |
---|
| 1105 | dfs(const GR &g,typename GR::Node s=INVALID) |
---|
| 1106 | { |
---|
| 1107 | return DfsWizard<DfsWizardBase<GR> >(g,s); |
---|
| 1108 | } |
---|
| 1109 | |
---|
[921] | 1110 | } //END OF NAMESPACE LEMON |
---|
[780] | 1111 | |
---|
| 1112 | #endif |
---|
| 1113 | |
---|