gravatar
alpar (Alpar Juttner)
alpar@cs.elte.hu
Merge
0 15 0
merge default
0 files changed:
↑ Collapse diff ↑
Ignore white space 6 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_BFS_H
20 20
#define LEMON_BFS_H
21 21

	
22 22
///\ingroup search
23 23
///\file
24 24
///\brief BFS algorithm.
25 25

	
26 26
#include <lemon/list_graph.h>
27 27
#include <lemon/bits/path_dump.h>
28 28
#include <lemon/core.h>
29 29
#include <lemon/error.h>
30 30
#include <lemon/maps.h>
31 31
#include <lemon/path.h>
32 32

	
33 33
namespace lemon {
34 34

	
35 35
  ///Default traits class of Bfs class.
36 36

	
37 37
  ///Default traits class of Bfs class.
38 38
  ///\tparam GR Digraph type.
39 39
  template<class GR>
40 40
  struct BfsDefaultTraits
41 41
  {
42 42
    ///The type of the digraph the algorithm runs on.
43 43
    typedef GR Digraph;
44 44

	
45 45
    ///\brief The type of the map that stores the predecessor
46 46
    ///arcs of the shortest paths.
47 47
    ///
48 48
    ///The type of the map that stores the predecessor
49 49
    ///arcs of the shortest paths.
50 50
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
51 51
    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
52 52
    ///Instantiates a \ref PredMap.
53 53

	
54 54
    ///This function instantiates a \ref PredMap.
55 55
    ///\param g is the digraph, to which we would like to define the
56 56
    ///\ref PredMap.
57
    ///\todo The digraph alone may be insufficient to initialize
58 57
    static PredMap *createPredMap(const Digraph &g)
59 58
    {
60 59
      return new PredMap(g);
61 60
    }
62 61

	
63 62
    ///The type of the map that indicates which nodes are processed.
64 63

	
65 64
    ///The type of the map that indicates which nodes are processed.
66 65
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
67
    ///By default it is a NullMap.
68 66
    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
69 67
    ///Instantiates a \ref ProcessedMap.
70 68

	
71 69
    ///This function instantiates a \ref ProcessedMap.
72 70
    ///\param g is the digraph, to which
73 71
    ///we would like to define the \ref ProcessedMap
74 72
#ifdef DOXYGEN
75 73
    static ProcessedMap *createProcessedMap(const Digraph &g)
76 74
#else
77 75
    static ProcessedMap *createProcessedMap(const Digraph &)
78 76
#endif
79 77
    {
80 78
      return new ProcessedMap();
81 79
    }
82 80

	
83 81
    ///The type of the map that indicates which nodes are reached.
84 82

	
85 83
    ///The type of the map that indicates which nodes are reached.
86 84
    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
87 85
    typedef typename Digraph::template NodeMap<bool> ReachedMap;
88 86
    ///Instantiates a \ref ReachedMap.
89 87

	
90 88
    ///This function instantiates a \ref ReachedMap.
91 89
    ///\param g is the digraph, to which
92 90
    ///we would like to define the \ref ReachedMap.
93 91
    static ReachedMap *createReachedMap(const Digraph &g)
94 92
    {
95 93
      return new ReachedMap(g);
96 94
    }
97 95

	
98 96
    ///The type of the map that stores the distances of the nodes.
99 97

	
100 98
    ///The type of the map that stores the distances of the nodes.
101 99
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
102 100
    typedef typename Digraph::template NodeMap<int> DistMap;
103 101
    ///Instantiates a \ref DistMap.
104 102

	
105 103
    ///This function instantiates a \ref DistMap.
106 104
    ///\param g is the digraph, to which we would like to define the
107 105
    ///\ref DistMap.
108 106
    static DistMap *createDistMap(const Digraph &g)
109 107
    {
110 108
      return new DistMap(g);
111 109
    }
112 110
  };
113 111

	
114 112
  ///%BFS algorithm class.
115 113

	
116 114
  ///\ingroup search
117 115
  ///This class provides an efficient implementation of the %BFS algorithm.
118 116
  ///
119 117
  ///There is also a \ref bfs() "function-type interface" for the BFS
120 118
  ///algorithm, which is convenient in the simplier cases and it can be
121 119
  ///used easier.
122 120
  ///
123 121
  ///\tparam GR The type of the digraph the algorithm runs on.
124 122
  ///The default value is \ref ListDigraph. The value of GR is not used
125 123
  ///directly by \ref Bfs, it is only passed to \ref BfsDefaultTraits.
126 124
  ///\tparam TR Traits class to set various data types used by the algorithm.
127 125
  ///The default traits class is
128 126
  ///\ref BfsDefaultTraits "BfsDefaultTraits<GR>".
129 127
  ///See \ref BfsDefaultTraits for the documentation of
130 128
  ///a Bfs traits class.
131 129
#ifdef DOXYGEN
132 130
  template <typename GR,
133 131
            typename TR>
134 132
#else
135 133
  template <typename GR=ListDigraph,
136 134
            typename TR=BfsDefaultTraits<GR> >
137 135
#endif
138 136
  class Bfs {
139 137
  public:
140 138
    ///\ref Exception for uninitialized parameters.
141 139

	
142 140
    ///This error represents problems in the initialization of the
143 141
    ///parameters of the algorithm.
144 142
    class UninitializedParameter : public lemon::UninitializedParameter {
145 143
    public:
146 144
      virtual const char* what() const throw() {
147 145
        return "lemon::Bfs::UninitializedParameter";
148 146
      }
149 147
    };
150 148

	
151 149
    ///The type of the digraph the algorithm runs on.
152 150
    typedef typename TR::Digraph Digraph;
153 151

	
154 152
    ///\brief The type of the map that stores the predecessor arcs of the
155 153
    ///shortest paths.
156 154
    typedef typename TR::PredMap PredMap;
157 155
    ///The type of the map that stores the distances of the nodes.
158 156
    typedef typename TR::DistMap DistMap;
159 157
    ///The type of the map that indicates which nodes are reached.
160 158
    typedef typename TR::ReachedMap ReachedMap;
161 159
    ///The type of the map that indicates which nodes are processed.
162 160
    typedef typename TR::ProcessedMap ProcessedMap;
163 161
    ///The type of the paths.
164 162
    typedef PredMapPath<Digraph, PredMap> Path;
165 163

	
166 164
    ///The traits class.
167 165
    typedef TR Traits;
168 166

	
169 167
  private:
170 168

	
171 169
    typedef typename Digraph::Node Node;
172 170
    typedef typename Digraph::NodeIt NodeIt;
173 171
    typedef typename Digraph::Arc Arc;
174 172
    typedef typename Digraph::OutArcIt OutArcIt;
175 173

	
176 174
    //Pointer to the underlying digraph.
177 175
    const Digraph *G;
178 176
    //Pointer to the map of predecessor arcs.
179 177
    PredMap *_pred;
180 178
    //Indicates if _pred is locally allocated (true) or not.
181 179
    bool local_pred;
182 180
    //Pointer to the map of distances.
183 181
    DistMap *_dist;
184 182
    //Indicates if _dist is locally allocated (true) or not.
185 183
    bool local_dist;
186 184
    //Pointer to the map of reached status of the nodes.
187 185
    ReachedMap *_reached;
188 186
    //Indicates if _reached is locally allocated (true) or not.
189 187
    bool local_reached;
190 188
    //Pointer to the map of processed status of the nodes.
191 189
    ProcessedMap *_processed;
192 190
    //Indicates if _processed is locally allocated (true) or not.
193 191
    bool local_processed;
194 192

	
195 193
    std::vector<typename Digraph::Node> _queue;
196 194
    int _queue_head,_queue_tail,_queue_next_dist;
197 195
    int _curr_dist;
198 196

	
199
    ///Creates the maps if necessary.
200
    ///\todo Better memory allocation (instead of new).
197
    //Creates the maps if necessary.
201 198
    void create_maps()
202 199
    {
203 200
      if(!_pred) {
204 201
        local_pred = true;
205 202
        _pred = Traits::createPredMap(*G);
206 203
      }
207 204
      if(!_dist) {
208 205
        local_dist = true;
209 206
        _dist = Traits::createDistMap(*G);
210 207
      }
211 208
      if(!_reached) {
212 209
        local_reached = true;
213 210
        _reached = Traits::createReachedMap(*G);
214 211
      }
215 212
      if(!_processed) {
216 213
        local_processed = true;
217 214
        _processed = Traits::createProcessedMap(*G);
218 215
      }
219 216
    }
220 217

	
221 218
  protected:
222 219

	
223 220
    Bfs() {}
224 221

	
225 222
  public:
226 223

	
227 224
    typedef Bfs Create;
228 225

	
229 226
    ///\name Named template parameters
230 227

	
231 228
    ///@{
232 229

	
233 230
    template <class T>
234 231
    struct SetPredMapTraits : public Traits {
235 232
      typedef T PredMap;
236 233
      static PredMap *createPredMap(const Digraph &)
237 234
      {
238 235
        throw UninitializedParameter();
239 236
      }
240 237
    };
241 238
    ///\brief \ref named-templ-param "Named parameter" for setting
242 239
    ///\ref PredMap type.
243 240
    ///
244 241
    ///\ref named-templ-param "Named parameter" for setting
245 242
    ///\ref PredMap type.
246 243
    template <class T>
247 244
    struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > {
248 245
      typedef Bfs< Digraph, SetPredMapTraits<T> > Create;
249 246
    };
250 247

	
251 248
    template <class T>
252 249
    struct SetDistMapTraits : public Traits {
253 250
      typedef T DistMap;
254 251
      static DistMap *createDistMap(const Digraph &)
255 252
      {
256 253
        throw UninitializedParameter();
257 254
      }
258 255
    };
259 256
    ///\brief \ref named-templ-param "Named parameter" for setting
260 257
    ///\ref DistMap type.
261 258
    ///
262 259
    ///\ref named-templ-param "Named parameter" for setting
263 260
    ///\ref DistMap type.
264 261
    template <class T>
265 262
    struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > {
266 263
      typedef Bfs< Digraph, SetDistMapTraits<T> > Create;
267 264
    };
268 265

	
269 266
    template <class T>
270 267
    struct SetReachedMapTraits : public Traits {
271 268
      typedef T ReachedMap;
272 269
      static ReachedMap *createReachedMap(const Digraph &)
273 270
      {
274 271
        throw UninitializedParameter();
275 272
      }
276 273
    };
277 274
    ///\brief \ref named-templ-param "Named parameter" for setting
278 275
    ///\ref ReachedMap type.
279 276
    ///
280 277
    ///\ref named-templ-param "Named parameter" for setting
281 278
    ///\ref ReachedMap type.
282 279
    template <class T>
283 280
    struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > {
284 281
      typedef Bfs< Digraph, SetReachedMapTraits<T> > Create;
285 282
    };
286 283

	
287 284
    template <class T>
288 285
    struct SetProcessedMapTraits : public Traits {
289 286
      typedef T ProcessedMap;
290 287
      static ProcessedMap *createProcessedMap(const Digraph &)
291 288
      {
292 289
        throw UninitializedParameter();
293 290
      }
294 291
    };
295 292
    ///\brief \ref named-templ-param "Named parameter" for setting
296 293
    ///\ref ProcessedMap type.
297 294
    ///
298 295
    ///\ref named-templ-param "Named parameter" for setting
299 296
    ///\ref ProcessedMap type.
300 297
    template <class T>
301 298
    struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > {
302 299
      typedef Bfs< Digraph, SetProcessedMapTraits<T> > Create;
303 300
    };
304 301

	
305 302
    struct SetStandardProcessedMapTraits : public Traits {
306 303
      typedef typename Digraph::template NodeMap<bool> ProcessedMap;
307 304
      static ProcessedMap *createProcessedMap(const Digraph &g)
308 305
      {
309 306
        return new ProcessedMap(g);
310 307
      }
311 308
    };
312 309
    ///\brief \ref named-templ-param "Named parameter" for setting
313 310
    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
314 311
    ///
315 312
    ///\ref named-templ-param "Named parameter" for setting
316 313
    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
317 314
    ///If you don't set it explicitly, it will be automatically allocated.
318 315
    struct SetStandardProcessedMap :
319 316
      public Bfs< Digraph, SetStandardProcessedMapTraits > {
320 317
      typedef Bfs< Digraph, SetStandardProcessedMapTraits > Create;
321 318
    };
322 319

	
323 320
    ///@}
324 321

	
325 322
  public:
326 323

	
327 324
    ///Constructor.
328 325

	
329 326
    ///Constructor.
330 327
    ///\param g The digraph the algorithm runs on.
331 328
    Bfs(const Digraph &g) :
332 329
      G(&g),
333 330
      _pred(NULL), local_pred(false),
334 331
      _dist(NULL), local_dist(false),
335 332
      _reached(NULL), local_reached(false),
336 333
      _processed(NULL), local_processed(false)
337 334
    { }
338 335

	
339 336
    ///Destructor.
340 337
    ~Bfs()
341 338
    {
342 339
      if(local_pred) delete _pred;
343 340
      if(local_dist) delete _dist;
344 341
      if(local_reached) delete _reached;
345 342
      if(local_processed) delete _processed;
346 343
    }
347 344

	
348 345
    ///Sets the map that stores the predecessor arcs.
349 346

	
350 347
    ///Sets the map that stores the predecessor arcs.
351 348
    ///If you don't use this function before calling \ref run(),
352 349
    ///it will allocate one. The destructor deallocates this
353 350
    ///automatically allocated map, of course.
354 351
    ///\return <tt> (*this) </tt>
355 352
    Bfs &predMap(PredMap &m)
356 353
    {
357 354
      if(local_pred) {
358 355
        delete _pred;
359 356
        local_pred=false;
360 357
      }
361 358
      _pred = &m;
362 359
      return *this;
363 360
    }
364 361

	
365 362
    ///Sets the map that indicates which nodes are reached.
366 363

	
367 364
    ///Sets the map that indicates which nodes are reached.
368 365
    ///If you don't use this function before calling \ref run(),
369 366
    ///it will allocate one. The destructor deallocates this
370 367
    ///automatically allocated map, of course.
371 368
    ///\return <tt> (*this) </tt>
372 369
    Bfs &reachedMap(ReachedMap &m)
373 370
    {
374 371
      if(local_reached) {
375 372
        delete _reached;
376 373
        local_reached=false;
377 374
      }
378 375
      _reached = &m;
379 376
      return *this;
380 377
    }
381 378

	
382 379
    ///Sets the map that indicates which nodes are processed.
383 380

	
384 381
    ///Sets the map that indicates which nodes are processed.
385 382
    ///If you don't use this function before calling \ref run(),
386 383
    ///it will allocate one. The destructor deallocates this
387 384
    ///automatically allocated map, of course.
388 385
    ///\return <tt> (*this) </tt>
389 386
    Bfs &processedMap(ProcessedMap &m)
390 387
    {
391 388
      if(local_processed) {
392 389
        delete _processed;
393 390
        local_processed=false;
394 391
      }
395 392
      _processed = &m;
396 393
      return *this;
397 394
    }
398 395

	
399 396
    ///Sets the map that stores the distances of the nodes.
400 397

	
401 398
    ///Sets the map that stores the distances of the nodes calculated by
402 399
    ///the algorithm.
403 400
    ///If you don't use this function before calling \ref run(),
404 401
    ///it will allocate one. The destructor deallocates this
405 402
    ///automatically allocated map, of course.
406 403
    ///\return <tt> (*this) </tt>
407 404
    Bfs &distMap(DistMap &m)
408 405
    {
409 406
      if(local_dist) {
410 407
        delete _dist;
411 408
        local_dist=false;
412 409
      }
413 410
      _dist = &m;
414 411
      return *this;
415 412
    }
416 413

	
417 414
  public:
418 415

	
419 416
    ///\name Execution control
420 417
    ///The simplest way to execute the algorithm is to use
421 418
    ///one of the member functions called \ref lemon::Bfs::run() "run()".
422 419
    ///\n
423 420
    ///If you need more control on the execution, first you must call
424 421
    ///\ref lemon::Bfs::init() "init()", then you can add several source
425 422
    ///nodes with \ref lemon::Bfs::addSource() "addSource()".
426 423
    ///Finally \ref lemon::Bfs::start() "start()" will perform the
427 424
    ///actual path computation.
428 425

	
429 426
    ///@{
430 427

	
431 428
    ///Initializes the internal data structures.
432 429

	
433 430
    ///Initializes the internal data structures.
434 431
    ///
435 432
    void init()
436 433
    {
437 434
      create_maps();
438 435
      _queue.resize(countNodes(*G));
439 436
      _queue_head=_queue_tail=0;
440 437
      _curr_dist=1;
441 438
      for ( NodeIt u(*G) ; u!=INVALID ; ++u ) {
442 439
        _pred->set(u,INVALID);
443 440
        _reached->set(u,false);
444 441
        _processed->set(u,false);
445 442
      }
446 443
    }
447 444

	
448 445
    ///Adds a new source node.
449 446

	
450 447
    ///Adds a new source node to the set of nodes to be processed.
451 448
    ///
452 449
    void addSource(Node s)
453 450
    {
454 451
      if(!(*_reached)[s])
455 452
        {
456 453
          _reached->set(s,true);
457 454
          _pred->set(s,INVALID);
458 455
          _dist->set(s,0);
459 456
          _queue[_queue_head++]=s;
460 457
          _queue_next_dist=_queue_head;
461 458
        }
462 459
    }
463 460

	
464 461
    ///Processes the next node.
465 462

	
466 463
    ///Processes the next node.
467 464
    ///
468 465
    ///\return The processed node.
469 466
    ///
470 467
    ///\pre The queue must not be empty.
471 468
    Node processNextNode()
472 469
    {
473 470
      if(_queue_tail==_queue_next_dist) {
474 471
        _curr_dist++;
475 472
        _queue_next_dist=_queue_head;
476 473
      }
477 474
      Node n=_queue[_queue_tail++];
478 475
      _processed->set(n,true);
479 476
      Node m;
480 477
      for(OutArcIt e(*G,n);e!=INVALID;++e)
481 478
        if(!(*_reached)[m=G->target(e)]) {
482 479
          _queue[_queue_head++]=m;
483 480
          _reached->set(m,true);
484 481
          _pred->set(m,e);
485 482
          _dist->set(m,_curr_dist);
486 483
        }
487 484
      return n;
488 485
    }
489 486

	
490 487
    ///Processes the next node.
491 488

	
492 489
    ///Processes the next node and checks if the given target node
493 490
    ///is reached. If the target node is reachable from the processed
494 491
    ///node, then the \c reach parameter will be set to \c true.
495 492
    ///
496 493
    ///\param target The target node.
497 494
    ///\retval reach Indicates if the target node is reached.
498 495
    ///It should be initially \c false.
499 496
    ///
500 497
    ///\return The processed node.
501 498
    ///
502 499
    ///\pre The queue must not be empty.
503 500
    Node processNextNode(Node target, bool& reach)
504 501
    {
505 502
      if(_queue_tail==_queue_next_dist) {
506 503
        _curr_dist++;
507 504
        _queue_next_dist=_queue_head;
508 505
      }
509 506
      Node n=_queue[_queue_tail++];
510 507
      _processed->set(n,true);
511 508
      Node m;
512 509
      for(OutArcIt e(*G,n);e!=INVALID;++e)
513 510
        if(!(*_reached)[m=G->target(e)]) {
514 511
          _queue[_queue_head++]=m;
515 512
          _reached->set(m,true);
516 513
          _pred->set(m,e);
517 514
          _dist->set(m,_curr_dist);
518 515
          reach = reach || (target == m);
519 516
        }
520 517
      return n;
521 518
    }
522 519

	
523 520
    ///Processes the next node.
524 521

	
525 522
    ///Processes the next node and checks if at least one of reached
526 523
    ///nodes has \c true value in the \c nm node map. If one node
527 524
    ///with \c true value is reachable from the processed node, then the
528 525
    ///\c rnode parameter will be set to the first of such nodes.
529 526
    ///
530 527
    ///\param nm A \c bool (or convertible) node map that indicates the
531 528
    ///possible targets.
532 529
    ///\retval rnode The reached target node.
533 530
    ///It should be initially \c INVALID.
534 531
    ///
535 532
    ///\return The processed node.
536 533
    ///
537 534
    ///\pre The queue must not be empty.
538 535
    template<class NM>
539 536
    Node processNextNode(const NM& nm, Node& rnode)
540 537
    {
541 538
      if(_queue_tail==_queue_next_dist) {
542 539
        _curr_dist++;
543 540
        _queue_next_dist=_queue_head;
544 541
      }
545 542
      Node n=_queue[_queue_tail++];
546 543
      _processed->set(n,true);
547 544
      Node m;
548 545
      for(OutArcIt e(*G,n);e!=INVALID;++e)
549 546
        if(!(*_reached)[m=G->target(e)]) {
550 547
          _queue[_queue_head++]=m;
551 548
          _reached->set(m,true);
552 549
          _pred->set(m,e);
553 550
          _dist->set(m,_curr_dist);
554 551
          if (nm[m] && rnode == INVALID) rnode = m;
555 552
        }
556 553
      return n;
557 554
    }
558 555

	
559 556
    ///The next node to be processed.
560 557

	
561 558
    ///Returns the next node to be processed or \c INVALID if the queue
562 559
    ///is empty.
563 560
    Node nextNode() const
564 561
    {
565 562
      return _queue_tail<_queue_head?_queue[_queue_tail]:INVALID;
566 563
    }
567 564

	
568 565
    ///\brief Returns \c false if there are nodes
569 566
    ///to be processed.
570 567
    ///
571 568
    ///Returns \c false if there are nodes
572 569
    ///to be processed in the queue.
573 570
    bool emptyQueue() const { return _queue_tail==_queue_head; }
574 571

	
575 572
    ///Returns the number of the nodes to be processed.
576 573

	
577 574
    ///Returns the number of the nodes to be processed in the queue.
578 575
    int queueSize() const { return _queue_head-_queue_tail; }
579 576

	
580 577
    ///Executes the algorithm.
581 578

	
582 579
    ///Executes the algorithm.
583 580
    ///
584 581
    ///This method runs the %BFS algorithm from the root node(s)
585 582
    ///in order to compute the shortest path to each node.
586 583
    ///
587 584
    ///The algorithm computes
588 585
    ///- the shortest path tree (forest),
589 586
    ///- the distance of each node from the root(s).
590 587
    ///
591 588
    ///\pre init() must be called and at least one root node should be
592 589
    ///added with addSource() before using this function.
593 590
    ///
594 591
    ///\note <tt>b.start()</tt> is just a shortcut of the following code.
595 592
    ///\code
596 593
    ///  while ( !b.emptyQueue() ) {
597 594
    ///    b.processNextNode();
598 595
    ///  }
599 596
    ///\endcode
600 597
    void start()
601 598
    {
602 599
      while ( !emptyQueue() ) processNextNode();
603 600
    }
604 601

	
605 602
    ///Executes the algorithm until the given target node is reached.
606 603

	
607 604
    ///Executes the algorithm until the given target node is reached.
608 605
    ///
609 606
    ///This method runs the %BFS algorithm from the root node(s)
610 607
    ///in order to compute the shortest path to \c dest.
611 608
    ///
612 609
    ///The algorithm computes
613 610
    ///- the shortest path to \c dest,
614 611
    ///- the distance of \c dest from the root(s).
615 612
    ///
616 613
    ///\pre init() must be called and at least one root node should be
617 614
    ///added with addSource() before using this function.
618 615
    ///
619 616
    ///\note <tt>b.start(t)</tt> is just a shortcut of the following code.
620 617
    ///\code
621 618
    ///  bool reach = false;
622 619
    ///  while ( !b.emptyQueue() && !reach ) {
623 620
    ///    b.processNextNode(t, reach);
624 621
    ///  }
625 622
    ///\endcode
626 623
    void start(Node dest)
627 624
    {
628 625
      bool reach = false;
629 626
      while ( !emptyQueue() && !reach ) processNextNode(dest, reach);
630 627
    }
631 628

	
632 629
    ///Executes the algorithm until a condition is met.
633 630

	
634 631
    ///Executes the algorithm until a condition is met.
635 632
    ///
636 633
    ///This method runs the %BFS algorithm from the root node(s) in
637 634
    ///order to compute the shortest path to a node \c v with
638 635
    /// <tt>nm[v]</tt> true, if such a node can be found.
639 636
    ///
640 637
    ///\param nm A \c bool (or convertible) node map. The algorithm
641 638
    ///will stop when it reaches a node \c v with <tt>nm[v]</tt> true.
642 639
    ///
643 640
    ///\return The reached node \c v with <tt>nm[v]</tt> true or
644 641
    ///\c INVALID if no such node was found.
645 642
    ///
646 643
    ///\pre init() must be called and at least one root node should be
647 644
    ///added with addSource() before using this function.
648 645
    ///
649 646
    ///\note <tt>b.start(nm)</tt> is just a shortcut of the following code.
650 647
    ///\code
651 648
    ///  Node rnode = INVALID;
652 649
    ///  while ( !b.emptyQueue() && rnode == INVALID ) {
653 650
    ///    b.processNextNode(nm, rnode);
654 651
    ///  }
655 652
    ///  return rnode;
656 653
    ///\endcode
657 654
    template<class NodeBoolMap>
658 655
    Node start(const NodeBoolMap &nm)
659 656
    {
660 657
      Node rnode = INVALID;
661 658
      while ( !emptyQueue() && rnode == INVALID ) {
662 659
        processNextNode(nm, rnode);
663 660
      }
664 661
      return rnode;
665 662
    }
666 663

	
667 664
    ///Runs the algorithm from the given node.
668 665

	
669 666
    ///This method runs the %BFS algorithm from node \c s
670 667
    ///in order to compute the shortest path to each node.
671 668
    ///
672 669
    ///The algorithm computes
673 670
    ///- the shortest path tree,
674 671
    ///- the distance of each node from the root.
675 672
    ///
676 673
    ///\note <tt>b.run(s)</tt> is just a shortcut of the following code.
677 674
    ///\code
678 675
    ///  b.init();
679 676
    ///  b.addSource(s);
680 677
    ///  b.start();
681 678
    ///\endcode
682 679
    void run(Node s) {
683 680
      init();
684 681
      addSource(s);
685 682
      start();
686 683
    }
687 684

	
688 685
    ///Finds the shortest path between \c s and \c t.
689 686

	
690 687
    ///This method runs the %BFS algorithm from node \c s
691 688
    ///in order to compute the shortest path to \c t.
692 689
    ///
693 690
    ///\return The length of the shortest <tt>s</tt>--<tt>t</tt> path,
694 691
    ///if \c t is reachable form \c s, \c 0 otherwise.
695 692
    ///
696 693
    ///\note Apart from the return value, <tt>b.run(s,t)</tt> is just a
697 694
    ///shortcut of the following code.
698 695
    ///\code
699 696
    ///  b.init();
700 697
    ///  b.addSource(s);
701 698
    ///  b.start(t);
702 699
    ///\endcode
703 700
    int run(Node s,Node t) {
704 701
      init();
705 702
      addSource(s);
706 703
      start(t);
707 704
      return reached(t) ? _curr_dist : 0;
708 705
    }
709 706

	
710 707
    ///Runs the algorithm to visit all nodes in the digraph.
711 708

	
712 709
    ///This method runs the %BFS algorithm in order to
713 710
    ///compute the shortest path to each node.
714 711
    ///
715 712
    ///The algorithm computes
716 713
    ///- the shortest path tree (forest),
717 714
    ///- the distance of each node from the root(s).
718 715
    ///
719 716
    ///\note <tt>b.run(s)</tt> is just a shortcut of the following code.
720 717
    ///\code
721 718
    ///  b.init();
722 719
    ///  for (NodeIt n(gr); n != INVALID; ++n) {
723 720
    ///    if (!b.reached(n)) {
724 721
    ///      b.addSource(n);
725 722
    ///      b.start();
726 723
    ///    }
727 724
    ///  }
728 725
    ///\endcode
729 726
    void run() {
730 727
      init();
731 728
      for (NodeIt n(*G); n != INVALID; ++n) {
732 729
        if (!reached(n)) {
733 730
          addSource(n);
734 731
          start();
735 732
        }
736 733
      }
737 734
    }
738 735

	
739 736
    ///@}
740 737

	
741 738
    ///\name Query Functions
742 739
    ///The result of the %BFS algorithm can be obtained using these
743 740
    ///functions.\n
744 741
    ///Either \ref lemon::Bfs::run() "run()" or \ref lemon::Bfs::start()
745 742
    ///"start()" must be called before using them.
746 743

	
747 744
    ///@{
748 745

	
749 746
    ///The shortest path to a node.
750 747

	
751 748
    ///Returns the shortest path to a node.
752 749
    ///
753 750
    ///\warning \c t should be reachable from the root(s).
754 751
    ///
755 752
    ///\pre Either \ref run() or \ref start() must be called before
756 753
    ///using this function.
757 754
    Path path(Node t) const { return Path(*G, *_pred, t); }
758 755

	
759 756
    ///The distance of a node from the root(s).
760 757

	
761 758
    ///Returns the distance of a node from the root(s).
762 759
    ///
763 760
    ///\warning If node \c v is not reachable from the root(s), then
764 761
    ///the return value of this function is undefined.
765 762
    ///
766 763
    ///\pre Either \ref run() or \ref start() must be called before
767 764
    ///using this function.
768 765
    int dist(Node v) const { return (*_dist)[v]; }
769 766

	
770 767
    ///Returns the 'previous arc' of the shortest path tree for a node.
771 768

	
772 769
    ///This function returns the 'previous arc' of the shortest path
773 770
    ///tree for the node \c v, i.e. it returns the last arc of a
774 771
    ///shortest path from the root(s) to \c v. It is \c INVALID if \c v
775 772
    ///is not reachable from the root(s) or if \c v is a root.
776 773
    ///
777 774
    ///The shortest path tree used here is equal to the shortest path
778 775
    ///tree used in \ref predNode().
779 776
    ///
780 777
    ///\pre Either \ref run() or \ref start() must be called before
781 778
    ///using this function.
782 779
    Arc predArc(Node v) const { return (*_pred)[v];}
783 780

	
784 781
    ///Returns the 'previous node' of the shortest path tree for a node.
785 782

	
786 783
    ///This function returns the 'previous node' of the shortest path
787 784
    ///tree for the node \c v, i.e. it returns the last but one node
788 785
    ///from a shortest path from the root(s) to \c v. It is \c INVALID
789 786
    ///if \c v is not reachable from the root(s) or if \c v is a root.
790 787
    ///
791 788
    ///The shortest path tree used here is equal to the shortest path
792 789
    ///tree used in \ref predArc().
793 790
    ///
794 791
    ///\pre Either \ref run() or \ref start() must be called before
795 792
    ///using this function.
796 793
    Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:
797 794
                                  G->source((*_pred)[v]); }
798 795

	
799 796
    ///\brief Returns a const reference to the node map that stores the
800 797
    /// distances of the nodes.
801 798
    ///
802 799
    ///Returns a const reference to the node map that stores the distances
803 800
    ///of the nodes calculated by the algorithm.
804 801
    ///
805 802
    ///\pre Either \ref run() or \ref init()
806 803
    ///must be called before using this function.
807 804
    const DistMap &distMap() const { return *_dist;}
808 805

	
809 806
    ///\brief Returns a const reference to the node map that stores the
810 807
    ///predecessor arcs.
811 808
    ///
812 809
    ///Returns a const reference to the node map that stores the predecessor
813 810
    ///arcs, which form the shortest path tree.
814 811
    ///
815 812
    ///\pre Either \ref run() or \ref init()
816 813
    ///must be called before using this function.
817 814
    const PredMap &predMap() const { return *_pred;}
818 815

	
819 816
    ///Checks if a node is reachable from the root(s).
820 817

	
821 818
    ///Returns \c true if \c v is reachable from the root(s).
822 819
    ///\pre Either \ref run() or \ref start()
823 820
    ///must be called before using this function.
824 821
    bool reached(Node v) const { return (*_reached)[v]; }
825 822

	
826 823
    ///@}
827 824
  };
828 825

	
829 826
  ///Default traits class of bfs() function.
830 827

	
831 828
  ///Default traits class of bfs() function.
832 829
  ///\tparam GR Digraph type.
833 830
  template<class GR>
834 831
  struct BfsWizardDefaultTraits
835 832
  {
836 833
    ///The type of the digraph the algorithm runs on.
837 834
    typedef GR Digraph;
838 835

	
839 836
    ///\brief The type of the map that stores the predecessor
840 837
    ///arcs of the shortest paths.
841 838
    ///
842 839
    ///The type of the map that stores the predecessor
843 840
    ///arcs of the shortest paths.
844 841
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
845 842
    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
846 843
    ///Instantiates a \ref PredMap.
847 844

	
848 845
    ///This function instantiates a \ref PredMap.
849 846
    ///\param g is the digraph, to which we would like to define the
850 847
    ///\ref PredMap.
851
    ///\todo The digraph alone may be insufficient to initialize
852 848
    static PredMap *createPredMap(const Digraph &g)
853 849
    {
854 850
      return new PredMap(g);
855 851
    }
856 852

	
857 853
    ///The type of the map that indicates which nodes are processed.
858 854

	
859 855
    ///The type of the map that indicates which nodes are processed.
860 856
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
861 857
    ///By default it is a NullMap.
862 858
    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
863 859
    ///Instantiates a \ref ProcessedMap.
864 860

	
865 861
    ///This function instantiates a \ref ProcessedMap.
866 862
    ///\param g is the digraph, to which
867 863
    ///we would like to define the \ref ProcessedMap.
868 864
#ifdef DOXYGEN
869 865
    static ProcessedMap *createProcessedMap(const Digraph &g)
870 866
#else
871 867
    static ProcessedMap *createProcessedMap(const Digraph &)
872 868
#endif
873 869
    {
874 870
      return new ProcessedMap();
875 871
    }
876 872

	
877 873
    ///The type of the map that indicates which nodes are reached.
878 874

	
879 875
    ///The type of the map that indicates which nodes are reached.
880 876
    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
881 877
    typedef typename Digraph::template NodeMap<bool> ReachedMap;
882 878
    ///Instantiates a \ref ReachedMap.
883 879

	
884 880
    ///This function instantiates a \ref ReachedMap.
885 881
    ///\param g is the digraph, to which
886 882
    ///we would like to define the \ref ReachedMap.
887 883
    static ReachedMap *createReachedMap(const Digraph &g)
888 884
    {
889 885
      return new ReachedMap(g);
890 886
    }
891 887

	
892 888
    ///The type of the map that stores the distances of the nodes.
893 889

	
894 890
    ///The type of the map that stores the distances of the nodes.
895 891
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
896 892
    typedef typename Digraph::template NodeMap<int> DistMap;
897 893
    ///Instantiates a \ref DistMap.
898 894

	
899 895
    ///This function instantiates a \ref DistMap.
900 896
    ///\param g is the digraph, to which we would like to define
901 897
    ///the \ref DistMap
902 898
    static DistMap *createDistMap(const Digraph &g)
903 899
    {
904 900
      return new DistMap(g);
905 901
    }
906 902

	
907 903
    ///The type of the shortest paths.
908 904

	
909 905
    ///The type of the shortest paths.
910 906
    ///It must meet the \ref concepts::Path "Path" concept.
911 907
    typedef lemon::Path<Digraph> Path;
912 908
  };
913 909

	
914 910
  /// Default traits class used by \ref BfsWizard
915 911

	
916 912
  /// To make it easier to use Bfs algorithm
917 913
  /// we have created a wizard class.
918 914
  /// This \ref BfsWizard class needs default traits,
919 915
  /// as well as the \ref Bfs class.
920 916
  /// The \ref BfsWizardBase is a class to be the default traits of the
921 917
  /// \ref BfsWizard class.
922 918
  template<class GR>
923 919
  class BfsWizardBase : public BfsWizardDefaultTraits<GR>
924 920
  {
925 921

	
926 922
    typedef BfsWizardDefaultTraits<GR> Base;
927 923
  protected:
928 924
    //The type of the nodes in the digraph.
929 925
    typedef typename Base::Digraph::Node Node;
930 926

	
931 927
    //Pointer to the digraph the algorithm runs on.
932 928
    void *_g;
933 929
    //Pointer to the map of reached nodes.
934 930
    void *_reached;
935 931
    //Pointer to the map of processed nodes.
936 932
    void *_processed;
937 933
    //Pointer to the map of predecessors arcs.
938 934
    void *_pred;
939 935
    //Pointer to the map of distances.
940 936
    void *_dist;
941 937
    //Pointer to the shortest path to the target node.
942 938
    void *_path;
943 939
    //Pointer to the distance of the target node.
944 940
    int *_di;
945 941

	
946 942
    public:
947 943
    /// Constructor.
948 944

	
949 945
    /// This constructor does not require parameters, therefore it initiates
950 946
    /// all of the attributes to \c 0.
951 947
    BfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0),
952 948
                      _dist(0), _path(0), _di(0) {}
953 949

	
954 950
    /// Constructor.
955 951

	
956 952
    /// This constructor requires one parameter,
957 953
    /// others are initiated to \c 0.
958 954
    /// \param g The digraph the algorithm runs on.
959 955
    BfsWizardBase(const GR &g) :
960 956
      _g(reinterpret_cast<void*>(const_cast<GR*>(&g))),
961 957
      _reached(0), _processed(0), _pred(0), _dist(0),  _path(0), _di(0) {}
962 958

	
963 959
  };
964 960

	
965 961
  /// Auxiliary class for the function-type interface of BFS algorithm.
966 962

	
967 963
  /// This auxiliary class is created to implement the
968 964
  /// \ref bfs() "function-type interface" of \ref Bfs algorithm.
969 965
  /// It does not have own \ref run() method, it uses the functions
970 966
  /// and features of the plain \ref Bfs.
971 967
  ///
972 968
  /// This class should only be used through the \ref bfs() function,
973 969
  /// which makes it easier to use the algorithm.
974 970
  template<class TR>
975 971
  class BfsWizard : public TR
976 972
  {
977 973
    typedef TR Base;
978 974

	
979 975
    ///The type of the digraph the algorithm runs on.
980 976
    typedef typename TR::Digraph Digraph;
981 977

	
982 978
    typedef typename Digraph::Node Node;
983 979
    typedef typename Digraph::NodeIt NodeIt;
984 980
    typedef typename Digraph::Arc Arc;
985 981
    typedef typename Digraph::OutArcIt OutArcIt;
986 982

	
987 983
    ///\brief The type of the map that stores the predecessor
988 984
    ///arcs of the shortest paths.
989 985
    typedef typename TR::PredMap PredMap;
990 986
    ///\brief The type of the map that stores the distances of the nodes.
991 987
    typedef typename TR::DistMap DistMap;
992 988
    ///\brief The type of the map that indicates which nodes are reached.
993 989
    typedef typename TR::ReachedMap ReachedMap;
994 990
    ///\brief The type of the map that indicates which nodes are processed.
995 991
    typedef typename TR::ProcessedMap ProcessedMap;
996 992
    ///The type of the shortest paths
997 993
    typedef typename TR::Path Path;
998 994

	
999 995
  public:
1000 996

	
1001 997
    /// Constructor.
1002 998
    BfsWizard() : TR() {}
1003 999

	
1004 1000
    /// Constructor that requires parameters.
1005 1001

	
1006 1002
    /// Constructor that requires parameters.
1007 1003
    /// These parameters will be the default values for the traits class.
1008 1004
    /// \param g The digraph the algorithm runs on.
1009 1005
    BfsWizard(const Digraph &g) :
1010 1006
      TR(g) {}
1011 1007

	
1012 1008
    ///Copy constructor
1013 1009
    BfsWizard(const TR &b) : TR(b) {}
1014 1010

	
1015 1011
    ~BfsWizard() {}
1016 1012

	
1017 1013
    ///Runs BFS algorithm from the given source node.
1018 1014

	
1019 1015
    ///This method runs BFS algorithm from node \c s
1020 1016
    ///in order to compute the shortest path to each node.
1021 1017
    void run(Node s)
1022 1018
    {
1023 1019
      Bfs<Digraph,TR> alg(*reinterpret_cast<const Digraph*>(Base::_g));
1024 1020
      if (Base::_pred)
1025 1021
        alg.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
1026 1022
      if (Base::_dist)
1027 1023
        alg.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
1028 1024
      if (Base::_reached)
1029 1025
        alg.reachedMap(*reinterpret_cast<ReachedMap*>(Base::_reached));
1030 1026
      if (Base::_processed)
1031 1027
        alg.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));
1032 1028
      if (s!=INVALID)
1033 1029
        alg.run(s);
1034 1030
      else
1035 1031
        alg.run();
1036 1032
    }
1037 1033

	
1038 1034
    ///Finds the shortest path between \c s and \c t.
1039 1035

	
1040 1036
    ///This method runs BFS algorithm from node \c s
1041 1037
    ///in order to compute the shortest path to node \c t
1042 1038
    ///(it stops searching when \c t is processed).
1043 1039
    ///
1044 1040
    ///\return \c true if \c t is reachable form \c s.
1045 1041
    bool run(Node s, Node t)
1046 1042
    {
1047 1043
      if (s==INVALID || t==INVALID) throw UninitializedParameter();
1048 1044
      Bfs<Digraph,TR> alg(*reinterpret_cast<const Digraph*>(Base::_g));
1049 1045
      if (Base::_pred)
1050 1046
        alg.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
1051 1047
      if (Base::_dist)
1052 1048
        alg.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
1053 1049
      if (Base::_reached)
1054 1050
        alg.reachedMap(*reinterpret_cast<ReachedMap*>(Base::_reached));
1055 1051
      if (Base::_processed)
1056 1052
        alg.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));
1057 1053
      alg.run(s,t);
1058 1054
      if (Base::_path)
1059 1055
        *reinterpret_cast<Path*>(Base::_path) = alg.path(t);
1060 1056
      if (Base::_di)
1061 1057
        *Base::_di = alg.dist(t);
1062 1058
      return alg.reached(t);
1063 1059
    }
1064 1060

	
1065 1061
    ///Runs BFS algorithm to visit all nodes in the digraph.
1066 1062

	
1067 1063
    ///This method runs BFS algorithm in order to compute
1068 1064
    ///the shortest path to each node.
1069 1065
    void run()
1070 1066
    {
1071 1067
      run(INVALID);
1072 1068
    }
1073 1069

	
1074 1070
    template<class T>
1075 1071
    struct SetPredMapBase : public Base {
1076 1072
      typedef T PredMap;
1077 1073
      static PredMap *createPredMap(const Digraph &) { return 0; };
1078 1074
      SetPredMapBase(const TR &b) : TR(b) {}
1079 1075
    };
1080 1076
    ///\brief \ref named-func-param "Named parameter"
1081 1077
    ///for setting \ref PredMap object.
1082 1078
    ///
1083 1079
    ///\ref named-func-param "Named parameter"
1084 1080
    ///for setting \ref PredMap object.
1085 1081
    template<class T>
1086 1082
    BfsWizard<SetPredMapBase<T> > predMap(const T &t)
1087 1083
    {
1088 1084
      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));
1089 1085
      return BfsWizard<SetPredMapBase<T> >(*this);
1090 1086
    }
1091 1087

	
1092 1088
    template<class T>
1093 1089
    struct SetReachedMapBase : public Base {
1094 1090
      typedef T ReachedMap;
1095 1091
      static ReachedMap *createReachedMap(const Digraph &) { return 0; };
1096 1092
      SetReachedMapBase(const TR &b) : TR(b) {}
1097 1093
    };
1098 1094
    ///\brief \ref named-func-param "Named parameter"
1099 1095
    ///for setting \ref ReachedMap object.
1100 1096
    ///
1101 1097
    /// \ref named-func-param "Named parameter"
1102 1098
    ///for setting \ref ReachedMap object.
1103 1099
    template<class T>
1104 1100
    BfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
1105 1101
    {
1106 1102
      Base::_reached=reinterpret_cast<void*>(const_cast<T*>(&t));
1107 1103
      return BfsWizard<SetReachedMapBase<T> >(*this);
1108 1104
    }
1109 1105

	
1110 1106
    template<class T>
1111 1107
    struct SetDistMapBase : public Base {
1112 1108
      typedef T DistMap;
1113 1109
      static DistMap *createDistMap(const Digraph &) { return 0; };
1114 1110
      SetDistMapBase(const TR &b) : TR(b) {}
1115 1111
    };
1116 1112
    ///\brief \ref named-func-param "Named parameter"
1117 1113
    ///for setting \ref DistMap object.
1118 1114
    ///
1119 1115
    /// \ref named-func-param "Named parameter"
1120 1116
    ///for setting \ref DistMap object.
1121 1117
    template<class T>
1122 1118
    BfsWizard<SetDistMapBase<T> > distMap(const T &t)
1123 1119
    {
1124 1120
      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));
1125 1121
      return BfsWizard<SetDistMapBase<T> >(*this);
1126 1122
    }
1127 1123

	
1128 1124
    template<class T>
1129 1125
    struct SetProcessedMapBase : public Base {
1130 1126
      typedef T ProcessedMap;
1131 1127
      static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
1132 1128
      SetProcessedMapBase(const TR &b) : TR(b) {}
1133 1129
    };
1134 1130
    ///\brief \ref named-func-param "Named parameter"
1135 1131
    ///for setting \ref ProcessedMap object.
1136 1132
    ///
1137 1133
    /// \ref named-func-param "Named parameter"
1138 1134
    ///for setting \ref ProcessedMap object.
1139 1135
    template<class T>
1140 1136
    BfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
1141 1137
    {
1142 1138
      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));
1143 1139
      return BfsWizard<SetProcessedMapBase<T> >(*this);
1144 1140
    }
1145 1141

	
1146 1142
    template<class T>
1147 1143
    struct SetPathBase : public Base {
1148 1144
      typedef T Path;
1149 1145
      SetPathBase(const TR &b) : TR(b) {}
1150 1146
    };
1151 1147
    ///\brief \ref named-func-param "Named parameter"
1152 1148
    ///for getting the shortest path to the target node.
1153 1149
    ///
1154 1150
    ///\ref named-func-param "Named parameter"
1155 1151
    ///for getting the shortest path to the target node.
1156 1152
    template<class T>
1157 1153
    BfsWizard<SetPathBase<T> > path(const T &t)
1158 1154
    {
1159 1155
      Base::_path=reinterpret_cast<void*>(const_cast<T*>(&t));
1160 1156
      return BfsWizard<SetPathBase<T> >(*this);
1161 1157
    }
1162 1158

	
1163 1159
    ///\brief \ref named-func-param "Named parameter"
1164 1160
    ///for getting the distance of the target node.
1165 1161
    ///
1166 1162
    ///\ref named-func-param "Named parameter"
1167 1163
    ///for getting the distance of the target node.
1168 1164
    BfsWizard dist(const int &d)
1169 1165
    {
1170 1166
      Base::_di=const_cast<int*>(&d);
1171 1167
      return *this;
1172 1168
    }
1173 1169

	
1174 1170
  };
1175 1171

	
1176 1172
  ///Function-type interface for BFS algorithm.
1177 1173

	
1178 1174
  /// \ingroup search
1179 1175
  ///Function-type interface for BFS algorithm.
1180 1176
  ///
1181 1177
  ///This function also has several \ref named-func-param "named parameters",
1182 1178
  ///they are declared as the members of class \ref BfsWizard.
1183 1179
  ///The following examples show how to use these parameters.
1184 1180
  ///\code
1185 1181
  ///  // Compute shortest path from node s to each node
1186 1182
  ///  bfs(g).predMap(preds).distMap(dists).run(s);
1187 1183
  ///
1188 1184
  ///  // Compute shortest path from s to t
1189 1185
  ///  bool reached = bfs(g).path(p).dist(d).run(s,t);
1190 1186
  ///\endcode
1191 1187
  ///\warning Don't forget to put the \ref BfsWizard::run() "run()"
1192 1188
  ///to the end of the parameter list.
1193 1189
  ///\sa BfsWizard
1194 1190
  ///\sa Bfs
1195 1191
  template<class GR>
1196 1192
  BfsWizard<BfsWizardBase<GR> >
1197 1193
  bfs(const GR &digraph)
1198 1194
  {
1199 1195
    return BfsWizard<BfsWizardBase<GR> >(digraph);
1200 1196
  }
1201 1197

	
1202 1198
#ifdef DOXYGEN
1203 1199
  /// \brief Visitor class for BFS.
1204 1200
  ///
1205 1201
  /// This class defines the interface of the BfsVisit events, and
1206 1202
  /// it could be the base of a real visitor class.
1207 1203
  template <typename _Digraph>
1208 1204
  struct BfsVisitor {
1209 1205
    typedef _Digraph Digraph;
1210 1206
    typedef typename Digraph::Arc Arc;
1211 1207
    typedef typename Digraph::Node Node;
1212 1208
    /// \brief Called for the source node(s) of the BFS.
1213 1209
    ///
1214 1210
    /// This function is called for the source node(s) of the BFS.
1215 1211
    void start(const Node& node) {}
1216 1212
    /// \brief Called when a node is reached first time.
1217 1213
    ///
1218 1214
    /// This function is called when a node is reached first time.
1219 1215
    void reach(const Node& node) {}
1220 1216
    /// \brief Called when a node is processed.
1221 1217
    ///
1222 1218
    /// This function is called when a node is processed.
1223 1219
    void process(const Node& node) {}
1224 1220
    /// \brief Called when an arc reaches a new node.
1225 1221
    ///
1226 1222
    /// This function is called when the BFS finds an arc whose target node
1227 1223
    /// is not reached yet.
1228 1224
    void discover(const Arc& arc) {}
1229 1225
    /// \brief Called when an arc is examined but its target node is
1230 1226
    /// already discovered.
1231 1227
    ///
1232 1228
    /// This function is called when an arc is examined but its target node is
1233 1229
    /// already discovered.
1234 1230
    void examine(const Arc& arc) {}
1235 1231
  };
1236 1232
#else
1237 1233
  template <typename _Digraph>
1238 1234
  struct BfsVisitor {
1239 1235
    typedef _Digraph Digraph;
1240 1236
    typedef typename Digraph::Arc Arc;
1241 1237
    typedef typename Digraph::Node Node;
1242 1238
    void start(const Node&) {}
1243 1239
    void reach(const Node&) {}
1244 1240
    void process(const Node&) {}
1245 1241
    void discover(const Arc&) {}
1246 1242
    void examine(const Arc&) {}
1247 1243

	
1248 1244
    template <typename _Visitor>
1249 1245
    struct Constraints {
1250 1246
      void constraints() {
1251 1247
        Arc arc;
1252 1248
        Node node;
1253 1249
        visitor.start(node);
1254 1250
        visitor.reach(node);
1255 1251
        visitor.process(node);
1256 1252
        visitor.discover(arc);
1257 1253
        visitor.examine(arc);
1258 1254
      }
1259 1255
      _Visitor& visitor;
1260 1256
    };
1261 1257
  };
1262 1258
#endif
1263 1259

	
1264 1260
  /// \brief Default traits class of BfsVisit class.
1265 1261
  ///
1266 1262
  /// Default traits class of BfsVisit class.
1267 1263
  /// \tparam _Digraph The type of the digraph the algorithm runs on.
1268 1264
  template<class _Digraph>
1269 1265
  struct BfsVisitDefaultTraits {
1270 1266

	
1271 1267
    /// \brief The type of the digraph the algorithm runs on.
1272 1268
    typedef _Digraph Digraph;
1273 1269

	
1274 1270
    /// \brief The type of the map that indicates which nodes are reached.
1275 1271
    ///
1276 1272
    /// The type of the map that indicates which nodes are reached.
1277 1273
    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
1278 1274
    typedef typename Digraph::template NodeMap<bool> ReachedMap;
1279 1275

	
1280 1276
    /// \brief Instantiates a \ref ReachedMap.
1281 1277
    ///
1282 1278
    /// This function instantiates a \ref ReachedMap.
1283 1279
    /// \param digraph is the digraph, to which
1284 1280
    /// we would like to define the \ref ReachedMap.
1285 1281
    static ReachedMap *createReachedMap(const Digraph &digraph) {
1286 1282
      return new ReachedMap(digraph);
1287 1283
    }
1288 1284

	
1289 1285
  };
1290 1286

	
1291 1287
  /// \ingroup search
1292 1288
  ///
1293 1289
  /// \brief %BFS algorithm class with visitor interface.
1294 1290
  ///
1295 1291
  /// This class provides an efficient implementation of the %BFS algorithm
1296 1292
  /// with visitor interface.
1297 1293
  ///
1298 1294
  /// The %BfsVisit class provides an alternative interface to the Bfs
1299 1295
  /// class. It works with callback mechanism, the BfsVisit object calls
1300 1296
  /// the member functions of the \c Visitor class on every BFS event.
1301 1297
  ///
1302 1298
  /// This interface of the BFS algorithm should be used in special cases
1303 1299
  /// when extra actions have to be performed in connection with certain
1304 1300
  /// events of the BFS algorithm. Otherwise consider to use Bfs or bfs()
1305 1301
  /// instead.
1306 1302
  ///
1307 1303
  /// \tparam _Digraph The type of the digraph the algorithm runs on.
1308 1304
  /// The default value is
1309 1305
  /// \ref ListDigraph. The value of _Digraph is not used directly by
1310 1306
  /// \ref BfsVisit, it is only passed to \ref BfsVisitDefaultTraits.
1311 1307
  /// \tparam _Visitor The Visitor type that is used by the algorithm.
1312 1308
  /// \ref BfsVisitor "BfsVisitor<_Digraph>" is an empty visitor, which
1313 1309
  /// does not observe the BFS events. If you want to observe the BFS
1314 1310
  /// events, you should implement your own visitor class.
1315 1311
  /// \tparam _Traits Traits class to set various data types used by the
1316 1312
  /// algorithm. The default traits class is
1317 1313
  /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits<_Digraph>".
1318 1314
  /// See \ref BfsVisitDefaultTraits for the documentation of
1319 1315
  /// a BFS visit traits class.
1320 1316
#ifdef DOXYGEN
1321 1317
  template <typename _Digraph, typename _Visitor, typename _Traits>
1322 1318
#else
1323 1319
  template <typename _Digraph = ListDigraph,
1324 1320
            typename _Visitor = BfsVisitor<_Digraph>,
1325 1321
            typename _Traits = BfsDefaultTraits<_Digraph> >
1326 1322
#endif
1327 1323
  class BfsVisit {
1328 1324
  public:
1329 1325

	
1330 1326
    /// \brief \ref Exception for uninitialized parameters.
1331 1327
    ///
1332 1328
    /// This error represents problems in the initialization
1333 1329
    /// of the parameters of the algorithm.
1334 1330
    class UninitializedParameter : public lemon::UninitializedParameter {
1335 1331
    public:
1336 1332
      virtual const char* what() const throw()
1337 1333
      {
1338 1334
        return "lemon::BfsVisit::UninitializedParameter";
1339 1335
      }
1340 1336
    };
1341 1337

	
1342 1338
    ///The traits class.
1343 1339
    typedef _Traits Traits;
1344 1340

	
1345 1341
    ///The type of the digraph the algorithm runs on.
1346 1342
    typedef typename Traits::Digraph Digraph;
1347 1343

	
1348 1344
    ///The visitor type used by the algorithm.
1349 1345
    typedef _Visitor Visitor;
1350 1346

	
1351 1347
    ///The type of the map that indicates which nodes are reached.
1352 1348
    typedef typename Traits::ReachedMap ReachedMap;
1353 1349

	
1354 1350
  private:
1355 1351

	
1356 1352
    typedef typename Digraph::Node Node;
1357 1353
    typedef typename Digraph::NodeIt NodeIt;
1358 1354
    typedef typename Digraph::Arc Arc;
1359 1355
    typedef typename Digraph::OutArcIt OutArcIt;
1360 1356

	
1361 1357
    //Pointer to the underlying digraph.
1362 1358
    const Digraph *_digraph;
1363 1359
    //Pointer to the visitor object.
1364 1360
    Visitor *_visitor;
1365 1361
    //Pointer to the map of reached status of the nodes.
1366 1362
    ReachedMap *_reached;
1367 1363
    //Indicates if _reached is locally allocated (true) or not.
1368 1364
    bool local_reached;
1369 1365

	
1370 1366
    std::vector<typename Digraph::Node> _list;
1371 1367
    int _list_front, _list_back;
1372 1368

	
1373
    ///Creates the maps if necessary.
1374
    ///\todo Better memory allocation (instead of new).
1369
    //Creates the maps if necessary.
1375 1370
    void create_maps() {
1376 1371
      if(!_reached) {
1377 1372
        local_reached = true;
1378 1373
        _reached = Traits::createReachedMap(*_digraph);
1379 1374
      }
1380 1375
    }
1381 1376

	
1382 1377
  protected:
1383 1378

	
1384 1379
    BfsVisit() {}
1385 1380

	
1386 1381
  public:
1387 1382

	
1388 1383
    typedef BfsVisit Create;
1389 1384

	
1390 1385
    /// \name Named template parameters
1391 1386

	
1392 1387
    ///@{
1393 1388
    template <class T>
1394 1389
    struct SetReachedMapTraits : public Traits {
1395 1390
      typedef T ReachedMap;
1396 1391
      static ReachedMap *createReachedMap(const Digraph &digraph) {
1397 1392
        throw UninitializedParameter();
1398 1393
      }
1399 1394
    };
1400 1395
    /// \brief \ref named-templ-param "Named parameter" for setting
1401 1396
    /// ReachedMap type.
1402 1397
    ///
1403 1398
    /// \ref named-templ-param "Named parameter" for setting ReachedMap type.
1404 1399
    template <class T>
1405 1400
    struct SetReachedMap : public BfsVisit< Digraph, Visitor,
1406 1401
                                            SetReachedMapTraits<T> > {
1407 1402
      typedef BfsVisit< Digraph, Visitor, SetReachedMapTraits<T> > Create;
1408 1403
    };
1409 1404
    ///@}
1410 1405

	
1411 1406
  public:
1412 1407

	
1413 1408
    /// \brief Constructor.
1414 1409
    ///
1415 1410
    /// Constructor.
1416 1411
    ///
1417 1412
    /// \param digraph The digraph the algorithm runs on.
1418 1413
    /// \param visitor The visitor object of the algorithm.
1419 1414
    BfsVisit(const Digraph& digraph, Visitor& visitor)
1420 1415
      : _digraph(&digraph), _visitor(&visitor),
1421 1416
        _reached(0), local_reached(false) {}
1422 1417

	
1423 1418
    /// \brief Destructor.
1424 1419
    ~BfsVisit() {
1425 1420
      if(local_reached) delete _reached;
1426 1421
    }
1427 1422

	
1428 1423
    /// \brief Sets the map that indicates which nodes are reached.
1429 1424
    ///
1430 1425
    /// Sets the map that indicates which nodes are reached.
1431 1426
    /// If you don't use this function before calling \ref run(),
1432 1427
    /// it will allocate one. The destructor deallocates this
1433 1428
    /// automatically allocated map, of course.
1434 1429
    /// \return <tt> (*this) </tt>
1435 1430
    BfsVisit &reachedMap(ReachedMap &m) {
1436 1431
      if(local_reached) {
1437 1432
        delete _reached;
1438 1433
        local_reached = false;
1439 1434
      }
1440 1435
      _reached = &m;
1441 1436
      return *this;
1442 1437
    }
1443 1438

	
1444 1439
  public:
1445 1440

	
1446 1441
    /// \name Execution control
1447 1442
    /// The simplest way to execute the algorithm is to use
1448 1443
    /// one of the member functions called \ref lemon::BfsVisit::run()
1449 1444
    /// "run()".
1450 1445
    /// \n
1451 1446
    /// If you need more control on the execution, first you must call
1452 1447
    /// \ref lemon::BfsVisit::init() "init()", then you can add several
1453 1448
    /// source nodes with \ref lemon::BfsVisit::addSource() "addSource()".
1454 1449
    /// Finally \ref lemon::BfsVisit::start() "start()" will perform the
1455 1450
    /// actual path computation.
1456 1451

	
1457 1452
    /// @{
1458 1453

	
1459 1454
    /// \brief Initializes the internal data structures.
1460 1455
    ///
1461 1456
    /// Initializes the internal data structures.
1462 1457
    void init() {
1463 1458
      create_maps();
1464 1459
      _list.resize(countNodes(*_digraph));
1465 1460
      _list_front = _list_back = -1;
1466 1461
      for (NodeIt u(*_digraph) ; u != INVALID ; ++u) {
1467 1462
        _reached->set(u, false);
1468 1463
      }
1469 1464
    }
1470 1465

	
1471 1466
    /// \brief Adds a new source node.
1472 1467
    ///
1473 1468
    /// Adds a new source node to the set of nodes to be processed.
1474 1469
    void addSource(Node s) {
1475 1470
      if(!(*_reached)[s]) {
1476 1471
          _reached->set(s,true);
1477 1472
          _visitor->start(s);
1478 1473
          _visitor->reach(s);
1479 1474
          _list[++_list_back] = s;
1480 1475
        }
1481 1476
    }
1482 1477

	
1483 1478
    /// \brief Processes the next node.
1484 1479
    ///
1485 1480
    /// Processes the next node.
1486 1481
    ///
1487 1482
    /// \return The processed node.
1488 1483
    ///
1489 1484
    /// \pre The queue must not be empty.
1490 1485
    Node processNextNode() {
1491 1486
      Node n = _list[++_list_front];
1492 1487
      _visitor->process(n);
1493 1488
      Arc e;
1494 1489
      for (_digraph->firstOut(e, n); e != INVALID; _digraph->nextOut(e)) {
1495 1490
        Node m = _digraph->target(e);
1496 1491
        if (!(*_reached)[m]) {
1497 1492
          _visitor->discover(e);
1498 1493
          _visitor->reach(m);
1499 1494
          _reached->set(m, true);
1500 1495
          _list[++_list_back] = m;
1501 1496
        } else {
1502 1497
          _visitor->examine(e);
1503 1498
        }
1504 1499
      }
1505 1500
      return n;
1506 1501
    }
1507 1502

	
1508 1503
    /// \brief Processes the next node.
1509 1504
    ///
1510 1505
    /// Processes the next node and checks if the given target node
1511 1506
    /// is reached. If the target node is reachable from the processed
1512 1507
    /// node, then the \c reach parameter will be set to \c true.
1513 1508
    ///
1514 1509
    /// \param target The target node.
1515 1510
    /// \retval reach Indicates if the target node is reached.
1516 1511
    /// It should be initially \c false.
1517 1512
    ///
1518 1513
    /// \return The processed node.
1519 1514
    ///
1520 1515
    /// \pre The queue must not be empty.
1521 1516
    Node processNextNode(Node target, bool& reach) {
1522 1517
      Node n = _list[++_list_front];
1523 1518
      _visitor->process(n);
1524 1519
      Arc e;
1525 1520
      for (_digraph->firstOut(e, n); e != INVALID; _digraph->nextOut(e)) {
1526 1521
        Node m = _digraph->target(e);
1527 1522
        if (!(*_reached)[m]) {
1528 1523
          _visitor->discover(e);
1529 1524
          _visitor->reach(m);
1530 1525
          _reached->set(m, true);
1531 1526
          _list[++_list_back] = m;
1532 1527
          reach = reach || (target == m);
1533 1528
        } else {
1534 1529
          _visitor->examine(e);
1535 1530
        }
1536 1531
      }
1537 1532
      return n;
1538 1533
    }
1539 1534

	
1540 1535
    /// \brief Processes the next node.
1541 1536
    ///
1542 1537
    /// Processes the next node and checks if at least one of reached
1543 1538
    /// nodes has \c true value in the \c nm node map. If one node
1544 1539
    /// with \c true value is reachable from the processed node, then the
1545 1540
    /// \c rnode parameter will be set to the first of such nodes.
1546 1541
    ///
1547 1542
    /// \param nm A \c bool (or convertible) node map that indicates the
1548 1543
    /// possible targets.
1549 1544
    /// \retval rnode The reached target node.
1550 1545
    /// It should be initially \c INVALID.
1551 1546
    ///
1552 1547
    /// \return The processed node.
1553 1548
    ///
1554 1549
    /// \pre The queue must not be empty.
1555 1550
    template <typename NM>
1556 1551
    Node processNextNode(const NM& nm, Node& rnode) {
1557 1552
      Node n = _list[++_list_front];
1558 1553
      _visitor->process(n);
1559 1554
      Arc e;
1560 1555
      for (_digraph->firstOut(e, n); e != INVALID; _digraph->nextOut(e)) {
1561 1556
        Node m = _digraph->target(e);
1562 1557
        if (!(*_reached)[m]) {
1563 1558
          _visitor->discover(e);
1564 1559
          _visitor->reach(m);
1565 1560
          _reached->set(m, true);
1566 1561
          _list[++_list_back] = m;
1567 1562
          if (nm[m] && rnode == INVALID) rnode = m;
1568 1563
        } else {
1569 1564
          _visitor->examine(e);
1570 1565
        }
1571 1566
      }
1572 1567
      return n;
1573 1568
    }
1574 1569

	
1575 1570
    /// \brief The next node to be processed.
1576 1571
    ///
1577 1572
    /// Returns the next node to be processed or \c INVALID if the queue
1578 1573
    /// is empty.
1579 1574
    Node nextNode() const {
1580 1575
      return _list_front != _list_back ? _list[_list_front + 1] : INVALID;
1581 1576
    }
1582 1577

	
1583 1578
    /// \brief Returns \c false if there are nodes
1584 1579
    /// to be processed.
1585 1580
    ///
1586 1581
    /// Returns \c false if there are nodes
1587 1582
    /// to be processed in the queue.
1588 1583
    bool emptyQueue() const { return _list_front == _list_back; }
1589 1584

	
1590 1585
    /// \brief Returns the number of the nodes to be processed.
1591 1586
    ///
1592 1587
    /// Returns the number of the nodes to be processed in the queue.
1593 1588
    int queueSize() const { return _list_back - _list_front; }
1594 1589

	
1595 1590
    /// \brief Executes the algorithm.
1596 1591
    ///
1597 1592
    /// Executes the algorithm.
1598 1593
    ///
1599 1594
    /// This method runs the %BFS algorithm from the root node(s)
1600 1595
    /// in order to compute the shortest path to each node.
1601 1596
    ///
1602 1597
    /// The algorithm computes
1603 1598
    /// - the shortest path tree (forest),
1604 1599
    /// - the distance of each node from the root(s).
1605 1600
    ///
1606 1601
    /// \pre init() must be called and at least one root node should be added
1607 1602
    /// with addSource() before using this function.
1608 1603
    ///
1609 1604
    /// \note <tt>b.start()</tt> is just a shortcut of the following code.
1610 1605
    /// \code
1611 1606
    ///   while ( !b.emptyQueue() ) {
1612 1607
    ///     b.processNextNode();
1613 1608
    ///   }
1614 1609
    /// \endcode
1615 1610
    void start() {
1616 1611
      while ( !emptyQueue() ) processNextNode();
1617 1612
    }
1618 1613

	
1619 1614
    /// \brief Executes the algorithm until the given target node is reached.
1620 1615
    ///
1621 1616
    /// Executes the algorithm until the given target node is reached.
1622 1617
    ///
1623 1618
    /// This method runs the %BFS algorithm from the root node(s)
1624 1619
    /// in order to compute the shortest path to \c dest.
1625 1620
    ///
1626 1621
    /// The algorithm computes
1627 1622
    /// - the shortest path to \c dest,
1628 1623
    /// - the distance of \c dest from the root(s).
1629 1624
    ///
1630 1625
    /// \pre init() must be called and at least one root node should be
1631 1626
    /// added with addSource() before using this function.
1632 1627
    ///
1633 1628
    /// \note <tt>b.start(t)</tt> is just a shortcut of the following code.
1634 1629
    /// \code
1635 1630
    ///   bool reach = false;
1636 1631
    ///   while ( !b.emptyQueue() && !reach ) {
1637 1632
    ///     b.processNextNode(t, reach);
1638 1633
    ///   }
1639 1634
    /// \endcode
1640 1635
    void start(Node dest) {
1641 1636
      bool reach = false;
1642 1637
      while ( !emptyQueue() && !reach ) processNextNode(dest, reach);
1643 1638
    }
1644 1639

	
1645 1640
    /// \brief Executes the algorithm until a condition is met.
1646 1641
    ///
1647 1642
    /// Executes the algorithm until a condition is met.
1648 1643
    ///
1649 1644
    /// This method runs the %BFS algorithm from the root node(s) in
1650 1645
    /// order to compute the shortest path to a node \c v with
1651 1646
    /// <tt>nm[v]</tt> true, if such a node can be found.
1652 1647
    ///
1653 1648
    /// \param nm must be a bool (or convertible) node map. The
1654 1649
    /// algorithm will stop when it reaches a node \c v with
1655 1650
    /// <tt>nm[v]</tt> true.
1656 1651
    ///
1657 1652
    /// \return The reached node \c v with <tt>nm[v]</tt> true or
1658 1653
    /// \c INVALID if no such node was found.
1659 1654
    ///
1660 1655
    /// \pre init() must be called and at least one root node should be
1661 1656
    /// added with addSource() before using this function.
1662 1657
    ///
1663 1658
    /// \note <tt>b.start(nm)</tt> is just a shortcut of the following code.
1664 1659
    /// \code
1665 1660
    ///   Node rnode = INVALID;
1666 1661
    ///   while ( !b.emptyQueue() && rnode == INVALID ) {
1667 1662
    ///     b.processNextNode(nm, rnode);
1668 1663
    ///   }
1669 1664
    ///   return rnode;
1670 1665
    /// \endcode
1671 1666
    template <typename NM>
1672 1667
    Node start(const NM &nm) {
1673 1668
      Node rnode = INVALID;
1674 1669
      while ( !emptyQueue() && rnode == INVALID ) {
1675 1670
        processNextNode(nm, rnode);
1676 1671
      }
1677 1672
      return rnode;
1678 1673
    }
1679 1674

	
1680 1675
    /// \brief Runs the algorithm from the given node.
1681 1676
    ///
1682 1677
    /// This method runs the %BFS algorithm from node \c s
1683 1678
    /// in order to compute the shortest path to each node.
1684 1679
    ///
1685 1680
    /// The algorithm computes
1686 1681
    /// - the shortest path tree,
1687 1682
    /// - the distance of each node from the root.
1688 1683
    ///
1689 1684
    /// \note <tt>b.run(s)</tt> is just a shortcut of the following code.
1690 1685
    ///\code
1691 1686
    ///   b.init();
1692 1687
    ///   b.addSource(s);
1693 1688
    ///   b.start();
1694 1689
    ///\endcode
1695 1690
    void run(Node s) {
1696 1691
      init();
1697 1692
      addSource(s);
1698 1693
      start();
1699 1694
    }
1700 1695

	
1701 1696
    /// \brief Runs the algorithm to visit all nodes in the digraph.
1702 1697
    ///
1703 1698
    /// This method runs the %BFS algorithm in order to
1704 1699
    /// compute the shortest path to each node.
1705 1700
    ///
1706 1701
    /// The algorithm computes
1707 1702
    /// - the shortest path tree (forest),
1708 1703
    /// - the distance of each node from the root(s).
1709 1704
    ///
1710 1705
    /// \note <tt>b.run(s)</tt> is just a shortcut of the following code.
1711 1706
    ///\code
1712 1707
    ///  b.init();
1713 1708
    ///  for (NodeIt n(gr); n != INVALID; ++n) {
1714 1709
    ///    if (!b.reached(n)) {
1715 1710
    ///      b.addSource(n);
1716 1711
    ///      b.start();
1717 1712
    ///    }
1718 1713
    ///  }
1719 1714
    ///\endcode
1720 1715
    void run() {
1721 1716
      init();
1722 1717
      for (NodeIt it(*_digraph); it != INVALID; ++it) {
1723 1718
        if (!reached(it)) {
1724 1719
          addSource(it);
1725 1720
          start();
1726 1721
        }
1727 1722
      }
1728 1723
    }
1729 1724

	
1730 1725
    ///@}
1731 1726

	
1732 1727
    /// \name Query Functions
1733 1728
    /// The result of the %BFS algorithm can be obtained using these
1734 1729
    /// functions.\n
1735 1730
    /// Either \ref lemon::BfsVisit::run() "run()" or
1736 1731
    /// \ref lemon::BfsVisit::start() "start()" must be called before
1737 1732
    /// using them.
1738 1733
    ///@{
1739 1734

	
1740 1735
    /// \brief Checks if a node is reachable from the root(s).
1741 1736
    ///
1742 1737
    /// Returns \c true if \c v is reachable from the root(s).
1743 1738
    /// \pre Either \ref run() or \ref start()
1744 1739
    /// must be called before using this function.
1745 1740
    bool reached(Node v) { return (*_reached)[v]; }
1746 1741

	
1747 1742
    ///@}
1748 1743

	
1749 1744
  };
1750 1745

	
1751 1746
} //END OF NAMESPACE LEMON
1752 1747

	
1753 1748
#endif
Ignore white space 6 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_BITS_BASE_EXTENDER_H
20 20
#define LEMON_BITS_BASE_EXTENDER_H
21 21

	
22 22
#include <lemon/core.h>
23 23
#include <lemon/error.h>
24 24

	
25 25
#include <lemon/bits/map_extender.h>
26 26
#include <lemon/bits/default_map.h>
27 27

	
28 28
#include <lemon/concept_check.h>
29 29
#include <lemon/concepts/maps.h>
30 30

	
31 31
///\ingroup digraphbits
32 32
///\file
33 33
///\brief Extenders for the digraph types
34 34
namespace lemon {
35 35

	
36 36
  /// \ingroup digraphbits
37 37
  ///
38 38
  /// \brief BaseDigraph to BaseGraph extender
39 39
  template <typename Base>
40 40
  class UndirDigraphExtender : public Base {
41 41

	
42 42
  public:
43 43

	
44 44
    typedef Base Parent;
45 45
    typedef typename Parent::Arc Edge;
46 46
    typedef typename Parent::Node Node;
47 47

	
48 48
    typedef True UndirectedTag;
49 49

	
50 50
    class Arc : public Edge {
51 51
      friend class UndirDigraphExtender;
52 52

	
53 53
    protected:
54 54
      bool forward;
55 55

	
56 56
      Arc(const Edge &ue, bool _forward) :
57 57
        Edge(ue), forward(_forward) {}
58 58

	
59 59
    public:
60 60
      Arc() {}
61 61

	
62 62
      // Invalid arc constructor
63 63
      Arc(Invalid i) : Edge(i), forward(true) {}
64 64

	
65 65
      bool operator==(const Arc &that) const {
66 66
        return forward==that.forward && Edge(*this)==Edge(that);
67 67
      }
68 68
      bool operator!=(const Arc &that) const {
69 69
        return forward!=that.forward || Edge(*this)!=Edge(that);
70 70
      }
71 71
      bool operator<(const Arc &that) const {
72 72
        return forward<that.forward ||
73 73
          (!(that.forward<forward) && Edge(*this)<Edge(that));
74 74
      }
75 75
    };
76 76

	
77 77
    /// First node of the edge
78 78
    Node u(const Edge &e) const {
79 79
      return Parent::source(e);
80 80
    }
81 81

	
82 82
    /// Source of the given arc
83 83
    Node source(const Arc &e) const {
84 84
      return e.forward ? Parent::source(e) : Parent::target(e);
85 85
    }
86 86

	
87 87
    /// Second node of the edge
88 88
    Node v(const Edge &e) const {
89 89
      return Parent::target(e);
90 90
    }
91 91

	
92 92
    /// Target of the given arc
93 93
    Node target(const Arc &e) const {
94 94
      return e.forward ? Parent::target(e) : Parent::source(e);
95 95
    }
96 96

	
97 97
    /// \brief Directed arc from an edge.
98 98
    ///
99 99
    /// Returns a directed arc corresponding to the specified edge.
100 100
    /// If the given bool is true, the first node of the given edge and
101 101
    /// the source node of the returned arc are the same.
102 102
    static Arc direct(const Edge &e, bool d) {
103 103
      return Arc(e, d);
104 104
    }
105 105

	
106 106
    /// Returns whether the given directed arc has the same orientation
107 107
    /// as the corresponding edge.
108
    ///
109
    /// \todo reference to the corresponding point of the undirected digraph
110
    /// concept. "What does the direction of an edge mean?"
111 108
    static bool direction(const Arc &a) { return a.forward; }
112 109

	
113 110
    using Parent::first;
114 111
    using Parent::next;
115 112

	
116 113
    void first(Arc &e) const {
117 114
      Parent::first(e);
118 115
      e.forward=true;
119 116
    }
120 117

	
121 118
    void next(Arc &e) const {
122 119
      if( e.forward ) {
123 120
        e.forward = false;
124 121
      }
125 122
      else {
126 123
        Parent::next(e);
127 124
        e.forward = true;
128 125
      }
129 126
    }
130 127

	
131 128
    void firstOut(Arc &e, const Node &n) const {
132 129
      Parent::firstIn(e,n);
133 130
      if( Edge(e) != INVALID ) {
134 131
        e.forward = false;
135 132
      }
136 133
      else {
137 134
        Parent::firstOut(e,n);
138 135
        e.forward = true;
139 136
      }
140 137
    }
141 138
    void nextOut(Arc &e) const {
142 139
      if( ! e.forward ) {
143 140
        Node n = Parent::target(e);
144 141
        Parent::nextIn(e);
145 142
        if( Edge(e) == INVALID ) {
146 143
          Parent::firstOut(e, n);
147 144
          e.forward = true;
148 145
        }
149 146
      }
150 147
      else {
151 148
        Parent::nextOut(e);
152 149
      }
153 150
    }
154 151

	
155 152
    void firstIn(Arc &e, const Node &n) const {
156 153
      Parent::firstOut(e,n);
157 154
      if( Edge(e) != INVALID ) {
158 155
        e.forward = false;
159 156
      }
160 157
      else {
161 158
        Parent::firstIn(e,n);
162 159
        e.forward = true;
163 160
      }
164 161
    }
165 162
    void nextIn(Arc &e) const {
166 163
      if( ! e.forward ) {
167 164
        Node n = Parent::source(e);
168 165
        Parent::nextOut(e);
169 166
        if( Edge(e) == INVALID ) {
170 167
          Parent::firstIn(e, n);
171 168
          e.forward = true;
172 169
        }
173 170
      }
174 171
      else {
175 172
        Parent::nextIn(e);
176 173
      }
177 174
    }
178 175

	
179 176
    void firstInc(Edge &e, bool &d, const Node &n) const {
180 177
      d = true;
181 178
      Parent::firstOut(e, n);
182 179
      if (e != INVALID) return;
183 180
      d = false;
184 181
      Parent::firstIn(e, n);
185 182
    }
186 183

	
187 184
    void nextInc(Edge &e, bool &d) const {
188 185
      if (d) {
189 186
        Node s = Parent::source(e);
190 187
        Parent::nextOut(e);
191 188
        if (e != INVALID) return;
192 189
        d = false;
193 190
        Parent::firstIn(e, s);
194 191
      } else {
195 192
        Parent::nextIn(e);
196 193
      }
197 194
    }
198 195

	
199 196
    Node nodeFromId(int ix) const {
200 197
      return Parent::nodeFromId(ix);
201 198
    }
202 199

	
203 200
    Arc arcFromId(int ix) const {
204 201
      return direct(Parent::arcFromId(ix >> 1), bool(ix & 1));
205 202
    }
206 203

	
207 204
    Edge edgeFromId(int ix) const {
208 205
      return Parent::arcFromId(ix);
209 206
    }
210 207

	
211 208
    int id(const Node &n) const {
212 209
      return Parent::id(n);
213 210
    }
214 211

	
215 212
    int id(const Edge &e) const {
216 213
      return Parent::id(e);
217 214
    }
218 215

	
219 216
    int id(const Arc &e) const {
220 217
      return 2 * Parent::id(e) + int(e.forward);
221 218
    }
222 219

	
223 220
    int maxNodeId() const {
224 221
      return Parent::maxNodeId();
225 222
    }
226 223

	
227 224
    int maxArcId() const {
228 225
      return 2 * Parent::maxArcId() + 1;
229 226
    }
230 227

	
231 228
    int maxEdgeId() const {
232 229
      return Parent::maxArcId();
233 230
    }
234 231

	
235 232
    int arcNum() const {
236 233
      return 2 * Parent::arcNum();
237 234
    }
238 235

	
239 236
    int edgeNum() const {
240 237
      return Parent::arcNum();
241 238
    }
242 239

	
243 240
    Arc findArc(Node s, Node t, Arc p = INVALID) const {
244 241
      if (p == INVALID) {
245 242
        Edge arc = Parent::findArc(s, t);
246 243
        if (arc != INVALID) return direct(arc, true);
247 244
        arc = Parent::findArc(t, s);
248 245
        if (arc != INVALID) return direct(arc, false);
249 246
      } else if (direction(p)) {
250 247
        Edge arc = Parent::findArc(s, t, p);
251 248
        if (arc != INVALID) return direct(arc, true);
252 249
        arc = Parent::findArc(t, s);
253 250
        if (arc != INVALID) return direct(arc, false);
254 251
      } else {
255 252
        Edge arc = Parent::findArc(t, s, p);
256 253
        if (arc != INVALID) return direct(arc, false);
257 254
      }
258 255
      return INVALID;
259 256
    }
260 257

	
261 258
    Edge findEdge(Node s, Node t, Edge p = INVALID) const {
262 259
      if (s != t) {
263 260
        if (p == INVALID) {
264 261
          Edge arc = Parent::findArc(s, t);
265 262
          if (arc != INVALID) return arc;
266 263
          arc = Parent::findArc(t, s);
267 264
          if (arc != INVALID) return arc;
268 265
        } else if (Parent::s(p) == s) {
269 266
          Edge arc = Parent::findArc(s, t, p);
270 267
          if (arc != INVALID) return arc;
271 268
          arc = Parent::findArc(t, s);
272 269
          if (arc != INVALID) return arc;
273 270
        } else {
274 271
          Edge arc = Parent::findArc(t, s, p);
275 272
          if (arc != INVALID) return arc;
276 273
        }
277 274
      } else {
278 275
        return Parent::findArc(s, t, p);
279 276
      }
280 277
      return INVALID;
281 278
    }
282 279
  };
283 280

	
284 281
  template <typename Base>
285 282
  class BidirBpGraphExtender : public Base {
286 283
  public:
287 284
    typedef Base Parent;
288 285
    typedef BidirBpGraphExtender Digraph;
289 286

	
290 287
    typedef typename Parent::Node Node;
291 288
    typedef typename Parent::Edge Edge;
292 289

	
293 290

	
294 291
    using Parent::first;
295 292
    using Parent::next;
296 293

	
297 294
    using Parent::id;
298 295

	
299 296
    class Red : public Node {
300 297
      friend class BidirBpGraphExtender;
301 298
    public:
302 299
      Red() {}
303 300
      Red(const Node& node) : Node(node) {
304 301
        LEMON_ASSERT(Parent::red(node) || node == INVALID,
305 302
                     typename Parent::NodeSetError());
306 303
      }
307 304
      Red& operator=(const Node& node) {
308 305
        LEMON_ASSERT(Parent::red(node) || node == INVALID,
309 306
                     typename Parent::NodeSetError());
310 307
        Node::operator=(node);
311 308
        return *this;
312 309
      }
313 310
      Red(Invalid) : Node(INVALID) {}
314 311
      Red& operator=(Invalid) {
315 312
        Node::operator=(INVALID);
316 313
        return *this;
317 314
      }
318 315
    };
319 316

	
320 317
    void first(Red& node) const {
321 318
      Parent::firstRed(static_cast<Node&>(node));
322 319
    }
323 320
    void next(Red& node) const {
324 321
      Parent::nextRed(static_cast<Node&>(node));
325 322
    }
326 323

	
327 324
    int id(const Red& node) const {
328 325
      return Parent::redId(node);
329 326
    }
330 327

	
331 328
    class Blue : public Node {
332 329
      friend class BidirBpGraphExtender;
333 330
    public:
334 331
      Blue() {}
335 332
      Blue(const Node& node) : Node(node) {
336 333
        LEMON_ASSERT(Parent::blue(node) || node == INVALID,
337 334
                     typename Parent::NodeSetError());
338 335
      }
339 336
      Blue& operator=(const Node& node) {
340 337
        LEMON_ASSERT(Parent::blue(node) || node == INVALID,
341 338
                     typename Parent::NodeSetError());
342 339
        Node::operator=(node);
343 340
        return *this;
344 341
      }
345 342
      Blue(Invalid) : Node(INVALID) {}
346 343
      Blue& operator=(Invalid) {
347 344
        Node::operator=(INVALID);
348 345
        return *this;
349 346
      }
350 347
    };
351 348

	
352 349
    void first(Blue& node) const {
353 350
      Parent::firstBlue(static_cast<Node&>(node));
354 351
    }
355 352
    void next(Blue& node) const {
356 353
      Parent::nextBlue(static_cast<Node&>(node));
357 354
    }
358 355

	
359 356
    int id(const Blue& node) const {
360 357
      return Parent::redId(node);
361 358
    }
362 359

	
363 360
    Node source(const Edge& arc) const {
364 361
      return red(arc);
365 362
    }
366 363
    Node target(const Edge& arc) const {
367 364
      return blue(arc);
368 365
    }
369 366

	
370 367
    void firstInc(Edge& arc, bool& dir, const Node& node) const {
371 368
      if (Parent::red(node)) {
372 369
        Parent::firstFromRed(arc, node);
373 370
        dir = true;
374 371
      } else {
375 372
        Parent::firstFromBlue(arc, node);
376 373
        dir = static_cast<Edge&>(arc) == INVALID;
377 374
      }
378 375
    }
379 376
    void nextInc(Edge& arc, bool& dir) const {
380 377
      if (dir) {
381 378
        Parent::nextFromRed(arc);
382 379
      } else {
383 380
        Parent::nextFromBlue(arc);
384 381
        if (arc == INVALID) dir = true;
385 382
      }
386 383
    }
387 384

	
388 385
    class Arc : public Edge {
389 386
      friend class BidirBpGraphExtender;
390 387
    protected:
391 388
      bool forward;
392 389

	
393 390
      Arc(const Edge& arc, bool _forward)
394 391
        : Edge(arc), forward(_forward) {}
395 392

	
396 393
    public:
397 394
      Arc() {}
398 395
      Arc (Invalid) : Edge(INVALID), forward(true) {}
399 396
      bool operator==(const Arc& i) const {
400 397
        return Edge::operator==(i) && forward == i.forward;
401 398
      }
402 399
      bool operator!=(const Arc& i) const {
403 400
        return Edge::operator!=(i) || forward != i.forward;
404 401
      }
405 402
      bool operator<(const Arc& i) const {
406 403
        return Edge::operator<(i) ||
407 404
          (!(i.forward<forward) && Edge(*this)<Edge(i));
408 405
      }
409 406
    };
410 407

	
411 408
    void first(Arc& arc) const {
412 409
      Parent::first(static_cast<Edge&>(arc));
413 410
      arc.forward = true;
414 411
    }
415 412

	
416 413
    void next(Arc& arc) const {
417 414
      if (!arc.forward) {
418 415
        Parent::next(static_cast<Edge&>(arc));
419 416
      }
420 417
      arc.forward = !arc.forward;
421 418
    }
422 419

	
423 420
    void firstOut(Arc& arc, const Node& node) const {
424 421
      if (Parent::red(node)) {
425 422
        Parent::firstFromRed(arc, node);
426 423
        arc.forward = true;
427 424
      } else {
428 425
        Parent::firstFromBlue(arc, node);
429 426
        arc.forward = static_cast<Edge&>(arc) == INVALID;
430 427
      }
431 428
    }
432 429
    void nextOut(Arc& arc) const {
433 430
      if (arc.forward) {
434 431
        Parent::nextFromRed(arc);
435 432
      } else {
436 433
        Parent::nextFromBlue(arc);
437 434
        arc.forward = static_cast<Edge&>(arc) == INVALID;
438 435
      }
439 436
    }
440 437

	
441 438
    void firstIn(Arc& arc, const Node& node) const {
442 439
      if (Parent::blue(node)) {
443 440
        Parent::firstFromBlue(arc, node);
444 441
        arc.forward = true;
445 442
      } else {
446 443
        Parent::firstFromRed(arc, node);
447 444
        arc.forward = static_cast<Edge&>(arc) == INVALID;
448 445
      }
449 446
    }
450 447
    void nextIn(Arc& arc) const {
451 448
      if (arc.forward) {
452 449
        Parent::nextFromBlue(arc);
453 450
      } else {
454 451
        Parent::nextFromRed(arc);
455 452
        arc.forward = static_cast<Edge&>(arc) == INVALID;
456 453
      }
457 454
    }
458 455

	
459 456
    Node source(const Arc& arc) const {
460 457
      return arc.forward ? Parent::red(arc) : Parent::blue(arc);
461 458
    }
462 459
    Node target(const Arc& arc) const {
463 460
      return arc.forward ? Parent::blue(arc) : Parent::red(arc);
464 461
    }
465 462

	
466 463
    int id(const Arc& arc) const {
467 464
      return (Parent::id(static_cast<const Edge&>(arc)) << 1) +
468 465
        (arc.forward ? 0 : 1);
469 466
    }
470 467
    Arc arcFromId(int ix) const {
471 468
      return Arc(Parent::fromEdgeId(ix >> 1), (ix & 1) == 0);
472 469
    }
473 470
    int maxArcId() const {
474 471
      return (Parent::maxEdgeId() << 1) + 1;
475 472
    }
476 473

	
477 474
    bool direction(const Arc& arc) const {
478 475
      return arc.forward;
479 476
    }
480 477

	
481 478
    Arc direct(const Edge& arc, bool dir) const {
482 479
      return Arc(arc, dir);
483 480
    }
484 481

	
485 482
    int arcNum() const {
486 483
      return 2 * Parent::edgeNum();
487 484
    }
488 485

	
489 486
    int edgeNum() const {
490 487
      return Parent::edgeNum();
491 488
    }
492 489

	
493 490

	
494 491
  };
Ignore white space 6 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_BITS_VECTOR_MAP_H
20 20
#define LEMON_BITS_VECTOR_MAP_H
21 21

	
22 22
#include <vector>
23 23
#include <algorithm>
24 24

	
25 25
#include <lemon/core.h>
26 26
#include <lemon/bits/alteration_notifier.h>
27 27

	
28 28
#include <lemon/concept_check.h>
29 29
#include <lemon/concepts/maps.h>
30 30

	
31 31
///\ingroup graphbits
32 32
///
33 33
///\file
34 34
///\brief Vector based graph maps.
35 35
namespace lemon {
36 36

	
37 37
  /// \ingroup graphbits
38 38
  ///
39 39
  /// \brief Graph map based on the std::vector storage.
40 40
  ///
41 41
  /// The VectorMap template class is graph map structure what
42 42
  /// automatically updates the map when a key is added to or erased from
43 43
  /// the map. This map type uses the std::vector to store the values.
44 44
  ///
45
  /// \tparam _Notifier The AlterationNotifier that will notify this map.
45
  /// \tparam _Graph The graph this map is attached to.
46 46
  /// \tparam _Item The item type of the graph items.
47 47
  /// \tparam _Value The value type of the map.
48
  /// \todo Fix the doc: there is _Graph parameter instead of _Notifier.
49 48
  template <typename _Graph, typename _Item, typename _Value>
50 49
  class VectorMap
51 50
    : public ItemSetTraits<_Graph, _Item>::ItemNotifier::ObserverBase {
52 51
  private:
53 52

	
54 53
    /// The container type of the map.
55 54
    typedef std::vector<_Value> Container;
56 55

	
57 56
  public:
58 57

	
59 58
    /// The graph type of the map.
60 59
    typedef _Graph Graph;
61 60
    /// The item type of the map.
62 61
    typedef _Item Item;
63 62
    /// The reference map tag.
64 63
    typedef True ReferenceMapTag;
65 64

	
66 65
    /// The key type of the map.
67 66
    typedef _Item Key;
68 67
    /// The value type of the map.
69 68
    typedef _Value Value;
70 69

	
71 70
    /// The notifier type.
72 71
    typedef typename ItemSetTraits<_Graph, _Item>::ItemNotifier Notifier;
73 72

	
74 73
    /// The map type.
75 74
    typedef VectorMap Map;
76 75
    /// The base class of the map.
77 76
    typedef typename Notifier::ObserverBase Parent;
78 77

	
79 78
    /// The reference type of the map;
80 79
    typedef typename Container::reference Reference;
81 80
    /// The const reference type of the map;
82 81
    typedef typename Container::const_reference ConstReference;
83 82

	
84 83

	
85 84
    /// \brief Constructor to attach the new map into the notifier.
86 85
    ///
87 86
    /// It constructs a map and attachs it into the notifier.
88 87
    /// It adds all the items of the graph to the map.
89 88
    VectorMap(const Graph& graph) {
90 89
      Parent::attach(graph.notifier(Item()));
91 90
      container.resize(Parent::notifier()->maxId() + 1);
92 91
    }
93 92

	
94 93
    /// \brief Constructor uses given value to initialize the map.
95 94
    ///
96 95
    /// It constructs a map uses a given value to initialize the map.
97 96
    /// It adds all the items of the graph to the map.
98 97
    VectorMap(const Graph& graph, const Value& value) {
99 98
      Parent::attach(graph.notifier(Item()));
100 99
      container.resize(Parent::notifier()->maxId() + 1, value);
101 100
    }
102 101

	
103 102
  private:
104 103
    /// \brief Copy constructor
105 104
    ///
106 105
    /// Copy constructor.
107 106
    VectorMap(const VectorMap& _copy) : Parent() {
108 107
      if (_copy.attached()) {
109 108
        Parent::attach(*_copy.notifier());
110 109
        container = _copy.container;
111 110
      }
112 111
    }
113 112

	
114 113
    /// \brief Assign operator.
115 114
    ///
116 115
    /// This operator assigns for each item in the map the
117 116
    /// value mapped to the same item in the copied map.
118 117
    /// The parameter map should be indiced with the same
119 118
    /// itemset because this assign operator does not change
120 119
    /// the container of the map.
121 120
    VectorMap& operator=(const VectorMap& cmap) {
122 121
      return operator=<VectorMap>(cmap);
123 122
    }
124 123

	
125 124

	
126 125
    /// \brief Template assign operator.
127 126
    ///
128 127
    /// The given parameter should be conform to the ReadMap
129 128
    /// concecpt and could be indiced by the current item set of
130 129
    /// the NodeMap. In this case the value for each item
131 130
    /// is assigned by the value of the given ReadMap.
132 131
    template <typename CMap>
133 132
    VectorMap& operator=(const CMap& cmap) {
134 133
      checkConcept<concepts::ReadMap<Key, _Value>, CMap>();
135 134
      const typename Parent::Notifier* nf = Parent::notifier();
136 135
      Item it;
137 136
      for (nf->first(it); it != INVALID; nf->next(it)) {
138 137
        set(it, cmap[it]);
139 138
      }
140 139
      return *this;
141 140
    }
142 141

	
143 142
  public:
144 143

	
145 144
    /// \brief The subcript operator.
146 145
    ///
147 146
    /// The subscript operator. The map can be subscripted by the
148 147
    /// actual items of the graph.
149 148
    Reference operator[](const Key& key) {
150 149
      return container[Parent::notifier()->id(key)];
151 150
    }
152 151

	
153 152
    /// \brief The const subcript operator.
154 153
    ///
155 154
    /// The const subscript operator. The map can be subscripted by the
156 155
    /// actual items of the graph.
157 156
    ConstReference operator[](const Key& key) const {
158 157
      return container[Parent::notifier()->id(key)];
159 158
    }
160 159

	
161 160

	
162 161
    /// \brief The setter function of the map.
163 162
    ///
164 163
    /// It the same as operator[](key) = value expression.
165 164
    void set(const Key& key, const Value& value) {
166 165
      (*this)[key] = value;
167 166
    }
168 167

	
169 168
  protected:
170 169

	
171 170
    /// \brief Adds a new key to the map.
172 171
    ///
173 172
    /// It adds a new key to the map. It called by the observer notifier
174 173
    /// and it overrides the add() member function of the observer base.
175 174
    virtual void add(const Key& key) {
176 175
      int id = Parent::notifier()->id(key);
177 176
      if (id >= int(container.size())) {
178 177
        container.resize(id + 1);
179 178
      }
180 179
    }
181 180

	
182 181
    /// \brief Adds more new keys to the map.
183 182
    ///
184 183
    /// It adds more new keys to the map. It called by the observer notifier
185 184
    /// and it overrides the add() member function of the observer base.
186 185
    virtual void add(const std::vector<Key>& keys) {
187 186
      int max = container.size() - 1;
188 187
      for (int i = 0; i < int(keys.size()); ++i) {
189 188
        int id = Parent::notifier()->id(keys[i]);
190 189
        if (id >= max) {
191 190
          max = id;
192 191
        }
193 192
      }
194 193
      container.resize(max + 1);
195 194
    }
196 195

	
197 196
    /// \brief Erase a key from the map.
198 197
    ///
199 198
    /// Erase a key from the map. It called by the observer notifier
200 199
    /// and it overrides the erase() member function of the observer base.
201 200
    virtual void erase(const Key& key) {
202 201
      container[Parent::notifier()->id(key)] = Value();
203 202
    }
204 203

	
205 204
    /// \brief Erase more keys from the map.
206 205
    ///
207 206
    /// Erase more keys from the map. It called by the observer notifier
208 207
    /// and it overrides the erase() member function of the observer base.
209 208
    virtual void erase(const std::vector<Key>& keys) {
210 209
      for (int i = 0; i < int(keys.size()); ++i) {
211 210
        container[Parent::notifier()->id(keys[i])] = Value();
212 211
      }
213 212
    }
214 213

	
215 214
    /// \brief Buildes the map.
216 215
    ///
217 216
    /// It buildes the map. It called by the observer notifier
218 217
    /// and it overrides the build() member function of the observer base.
219 218
    virtual void build() {
220 219
      int size = Parent::notifier()->maxId() + 1;
221 220
      container.reserve(size);
222 221
      container.resize(size);
223 222
    }
224 223

	
225 224
    /// \brief Clear the map.
226 225
    ///
227 226
    /// It erase all items from the map. It called by the observer notifier
228 227
    /// and it overrides the clear() member function of the observer base.
229 228
    virtual void clear() {
230 229
      container.clear();
231 230
    }
232 231

	
233 232
  private:
234 233

	
235 234
    Container container;
236 235

	
237 236
  };
238 237

	
239 238
}
240 239

	
241 240
#endif
Ignore white space 6 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
// This file contains a modified version of the concept checking
20 20
// utility from BOOST.
21 21
// See the appropriate copyright notice below.
22 22

	
23 23
// (C) Copyright Jeremy Siek 2000.
24 24
// Distributed under the Boost Software License, Version 1.0. (See
25 25
// accompanying file LICENSE_1_0.txt or copy at
26 26
// http://www.boost.org/LICENSE_1_0.txt)
27 27
//
28 28
// Revision History:
29 29
//   05 May   2001: Workarounds for HP aCC from Thomas Matelich. (Jeremy Siek)
30 30
//   02 April 2001: Removed limits header altogether. (Jeremy Siek)
31 31
//   01 April 2001: Modified to use new <boost/limits.hpp> header. (JMaddock)
32 32
//
33 33

	
34 34
// See http://www.boost.org/libs/concept_check for documentation.
35 35

	
36 36
///\file
37 37
///\brief Basic utilities for concept checking.
38 38
///
39
///\todo Are we still using BOOST concept checking utility?
40
///Is the BOOST copyright notice necessary?
41 39

	
42 40
#ifndef LEMON_CONCEPT_CHECK_H
43 41
#define LEMON_CONCEPT_CHECK_H
44 42

	
45 43
namespace lemon {
46 44

	
47 45
  /*
48 46
    "inline" is used for ignore_unused_variable_warning()
49 47
    and function_requires() to make sure there is no
50 48
    overtarget with g++.
51 49
  */
52 50

	
53 51
  template <class T> inline void ignore_unused_variable_warning(const T&) { }
54 52

	
55 53
  ///\e
56 54
  template <class Concept>
57 55
  inline void function_requires()
58 56
  {
59 57
#if !defined(NDEBUG)
60 58
    void (Concept::*x)() = & Concept::constraints;
61 59
    ignore_unused_variable_warning(x);
62 60
#endif
63 61
  }
64 62

	
65 63
  ///\e
66 64
  template <typename Concept, typename Type>
67 65
  inline void checkConcept() {
68 66
#if !defined(NDEBUG)
69 67
    typedef typename Concept::template Constraints<Type> ConceptCheck;
70 68
    void (ConceptCheck::*x)() = & ConceptCheck::constraints;
71 69
    ignore_unused_variable_warning(x);
72 70
#endif
73 71
  }
74 72

	
75 73
} // namespace lemon
76 74

	
77 75
#endif // LEMON_CONCEPT_CHECK_H
Ignore white space 6 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
///\ingroup concept
20 20
///\file
21 21
///\brief Classes for representing paths in digraphs.
22 22
///
23
///\todo Iterators have obsolete style
24 23

	
25 24
#ifndef LEMON_CONCEPT_PATH_H
26 25
#define LEMON_CONCEPT_PATH_H
27 26

	
28 27
#include <lemon/core.h>
29 28
#include <lemon/concept_check.h>
30 29

	
31 30
namespace lemon {
32 31
  namespace concepts {
33 32

	
34 33
    /// \addtogroup concept
35 34
    /// @{
36 35

	
37 36
    /// \brief A skeleton structure for representing directed paths in
38 37
    /// a digraph.
39 38
    ///
40 39
    /// A skeleton structure for representing directed paths in a
41 40
    /// digraph.
42 41
    /// \tparam _Digraph The digraph type in which the path is.
43 42
    ///
44 43
    /// In a sense, the path can be treated as a list of arcs. The
45 44
    /// lemon path type stores just this list. As a consequence it
46 45
    /// cannot enumerate the nodes in the path and the zero length
47 46
    /// paths cannot store the source.
48 47
    ///
49 48
    template <typename _Digraph>
50 49
    class Path {
51 50
    public:
52 51

	
53 52
      /// Type of the underlying digraph.
54 53
      typedef _Digraph Digraph;
55 54
      /// Arc type of the underlying digraph.
56 55
      typedef typename Digraph::Arc Arc;
57 56

	
58 57
      class ArcIt;
59 58

	
60 59
      /// \brief Default constructor
61 60
      Path() {}
62 61

	
63 62
      /// \brief Template constructor
64 63
      template <typename CPath>
65 64
      Path(const CPath& cpath) {}
66 65

	
67 66
      /// \brief Template assigment
68 67
      template <typename CPath>
69 68
      Path& operator=(const CPath& cpath) {
70 69
        ignore_unused_variable_warning(cpath);
71 70
        return *this;
72 71
      }
73 72

	
74 73
      /// Length of the path ie. the number of arcs in the path.
75 74
      int length() const { return 0;}
76 75

	
77 76
      /// Returns whether the path is empty.
78 77
      bool empty() const { return true;}
79 78

	
80 79
      /// Resets the path to an empty path.
81 80
      void clear() {}
82 81

	
83 82
      /// \brief LEMON style iterator for path arcs
84 83
      ///
85 84
      /// This class is used to iterate on the arcs of the paths.
86 85
      class ArcIt {
87 86
      public:
88 87
        /// Default constructor
89 88
        ArcIt() {}
90 89
        /// Invalid constructor
91 90
        ArcIt(Invalid) {}
92 91
        /// Constructor for first arc
93 92
        ArcIt(const Path &) {}
94 93

	
95 94
        /// Conversion to Arc
96 95
        operator Arc() const { return INVALID; }
97 96

	
98 97
        /// Next arc
99 98
        ArcIt& operator++() {return *this;}
100 99

	
101 100
        /// Comparison operator
102 101
        bool operator==(const ArcIt&) const {return true;}
103 102
        /// Comparison operator
104 103
        bool operator!=(const ArcIt&) const {return true;}
105 104
        /// Comparison operator
106 105
        bool operator<(const ArcIt&) const {return false;}
107 106

	
108 107
      };
109 108

	
110 109
      template <typename _Path>
111 110
      struct Constraints {
112 111
        void constraints() {
113 112
          Path<Digraph> pc;
114 113
          _Path p, pp(pc);
115 114
          int l = p.length();
116 115
          int e = p.empty();
117 116
          p.clear();
118 117

	
119 118
          p = pc;
120 119

	
121 120
          typename _Path::ArcIt id, ii(INVALID), i(p);
122 121

	
123 122
          ++i;
124 123
          typename Digraph::Arc ed = i;
125 124

	
126 125
          e = (i == ii);
127 126
          e = (i != ii);
128 127
          e = (i < ii);
129 128

	
130 129
          ignore_unused_variable_warning(l);
131 130
          ignore_unused_variable_warning(pp);
132 131
          ignore_unused_variable_warning(e);
133 132
          ignore_unused_variable_warning(id);
134 133
          ignore_unused_variable_warning(ii);
135 134
          ignore_unused_variable_warning(ed);
136 135
        }
137 136
      };
138 137

	
139 138
    };
140 139

	
141 140
    namespace _path_bits {
142 141

	
143 142
      template <typename _Digraph, typename _Path, typename RevPathTag = void>
144 143
      struct PathDumperConstraints {
145 144
        void constraints() {
146 145
          int l = p.length();
147 146
          int e = p.empty();
148 147

	
149 148
          typename _Path::ArcIt id, i(p);
150 149

	
151 150
          ++i;
152 151
          typename _Digraph::Arc ed = i;
153 152

	
154 153
          e = (i == INVALID);
155 154
          e = (i != INVALID);
156 155

	
157 156
          ignore_unused_variable_warning(l);
158 157
          ignore_unused_variable_warning(e);
159 158
          ignore_unused_variable_warning(id);
160 159
          ignore_unused_variable_warning(ed);
161 160
        }
162 161
        _Path& p;
163 162
      };
164 163

	
165 164
      template <typename _Digraph, typename _Path>
166 165
      struct PathDumperConstraints<
167 166
        _Digraph, _Path,
168 167
        typename enable_if<typename _Path::RevPathTag, void>::type
169 168
      > {
170 169
        void constraints() {
171 170
          int l = p.length();
172 171
          int e = p.empty();
173 172

	
174 173
          typename _Path::RevArcIt id, i(p);
175 174

	
176 175
          ++i;
177 176
          typename _Digraph::Arc ed = i;
178 177

	
179 178
          e = (i == INVALID);
180 179
          e = (i != INVALID);
181 180

	
182 181
          ignore_unused_variable_warning(l);
183 182
          ignore_unused_variable_warning(e);
184 183
          ignore_unused_variable_warning(id);
185 184
          ignore_unused_variable_warning(ed);
186 185
        }
187 186
        _Path& p;
188 187
      };
189 188

	
190 189
    }
191 190

	
192 191

	
193 192
    /// \brief A skeleton structure for path dumpers.
194 193
    ///
195 194
    /// A skeleton structure for path dumpers. The path dumpers are
196 195
    /// the generalization of the paths. The path dumpers can
197 196
    /// enumerate the arcs of the path wheter in forward or in
198 197
    /// backward order.  In most time these classes are not used
199 198
    /// directly rather it used to assign a dumped class to a real
200 199
    /// path type.
201 200
    ///
202 201
    /// The main purpose of this concept is that the shortest path
203 202
    /// algorithms can enumerate easily the arcs in reverse order.
204 203
    /// If we would like to give back a real path from these
205 204
    /// algorithms then we should create a temporarly path object. In
206 205
    /// LEMON such algorithms gives back a path dumper what can
207 206
    /// assigned to a real path and the dumpers can be implemented as
208 207
    /// an adaptor class to the predecessor map.
209 208

	
210 209
    /// \tparam _Digraph  The digraph type in which the path is.
211 210
    ///
212 211
    /// The paths can be constructed from any path type by a
213 212
    /// template constructor or a template assignment operator.
214 213
    ///
215 214
    template <typename _Digraph>
216 215
    class PathDumper {
217 216
    public:
218 217

	
219 218
      /// Type of the underlying digraph.
220 219
      typedef _Digraph Digraph;
221 220
      /// Arc type of the underlying digraph.
222 221
      typedef typename Digraph::Arc Arc;
223 222

	
224 223
      /// Length of the path ie. the number of arcs in the path.
225 224
      int length() const { return 0;}
226 225

	
227 226
      /// Returns whether the path is empty.
228 227
      bool empty() const { return true;}
229 228

	
230 229
      /// \brief Forward or reverse dumping
231 230
      ///
232 231
      /// If the RevPathTag is defined and true then reverse dumping
233 232
      /// is provided in the path dumper. In this case instead of the
234 233
      /// ArcIt the RevArcIt iterator should be implemented in the
235 234
      /// dumper.
236 235
      typedef False RevPathTag;
237 236

	
238 237
      /// \brief LEMON style iterator for path arcs
239 238
      ///
240 239
      /// This class is used to iterate on the arcs of the paths.
241 240
      class ArcIt {
242 241
      public:
243 242
        /// Default constructor
244 243
        ArcIt() {}
245 244
        /// Invalid constructor
246 245
        ArcIt(Invalid) {}
247 246
        /// Constructor for first arc
248 247
        ArcIt(const PathDumper&) {}
249 248

	
250 249
        /// Conversion to Arc
251 250
        operator Arc() const { return INVALID; }
252 251

	
253 252
        /// Next arc
254 253
        ArcIt& operator++() {return *this;}
255 254

	
256 255
        /// Comparison operator
257 256
        bool operator==(const ArcIt&) const {return true;}
258 257
        /// Comparison operator
259 258
        bool operator!=(const ArcIt&) const {return true;}
260 259
        /// Comparison operator
261 260
        bool operator<(const ArcIt&) const {return false;}
262 261

	
263 262
      };
264 263

	
265 264
      /// \brief LEMON style iterator for path arcs
266 265
      ///
267 266
      /// This class is used to iterate on the arcs of the paths in
268 267
      /// reverse direction.
269 268
      class RevArcIt {
270 269
      public:
271 270
        /// Default constructor
272 271
        RevArcIt() {}
273 272
        /// Invalid constructor
274 273
        RevArcIt(Invalid) {}
275 274
        /// Constructor for first arc
276 275
        RevArcIt(const PathDumper &) {}
277 276

	
278 277
        /// Conversion to Arc
279 278
        operator Arc() const { return INVALID; }
280 279

	
281 280
        /// Next arc
282 281
        RevArcIt& operator++() {return *this;}
283 282

	
284 283
        /// Comparison operator
285 284
        bool operator==(const RevArcIt&) const {return true;}
286 285
        /// Comparison operator
287 286
        bool operator!=(const RevArcIt&) const {return true;}
288 287
        /// Comparison operator
289 288
        bool operator<(const RevArcIt&) const {return false;}
290 289

	
291 290
      };
292 291

	
293 292
      template <typename _Path>
294 293
      struct Constraints {
295 294
        void constraints() {
296 295
          function_requires<_path_bits::
297 296
            PathDumperConstraints<Digraph, _Path> >();
298 297
        }
299 298
      };
300 299

	
301 300
    };
302 301

	
303 302

	
304 303
    ///@}
305 304
  }
306 305

	
307 306
} // namespace lemon
308 307

	
309 308
#endif // LEMON_CONCEPT_PATH_H
Ignore white space 6 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_DFS_H
20 20
#define LEMON_DFS_H
21 21

	
22 22
///\ingroup search
23 23
///\file
24 24
///\brief DFS algorithm.
25 25

	
26 26
#include <lemon/list_graph.h>
27 27
#include <lemon/bits/path_dump.h>
28 28
#include <lemon/core.h>
29 29
#include <lemon/error.h>
30 30
#include <lemon/assert.h>
31 31
#include <lemon/maps.h>
32 32
#include <lemon/path.h>
33 33

	
34 34
namespace lemon {
35 35

	
36 36
  ///Default traits class of Dfs class.
37 37

	
38 38
  ///Default traits class of Dfs class.
39 39
  ///\tparam GR Digraph type.
40 40
  template<class GR>
41 41
  struct DfsDefaultTraits
42 42
  {
43 43
    ///The type of the digraph the algorithm runs on.
44 44
    typedef GR Digraph;
45 45

	
46 46
    ///\brief The type of the map that stores the predecessor
47 47
    ///arcs of the %DFS paths.
48 48
    ///
49 49
    ///The type of the map that stores the predecessor
50 50
    ///arcs of the %DFS paths.
51 51
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
52 52
    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
53 53
    ///Instantiates a \ref PredMap.
54 54

	
55 55
    ///This function instantiates a \ref PredMap.
56 56
    ///\param g is the digraph, to which we would like to define the
57 57
    ///\ref PredMap.
58
    ///\todo The digraph alone may be insufficient to initialize
59 58
    static PredMap *createPredMap(const Digraph &g)
60 59
    {
61 60
      return new PredMap(g);
62 61
    }
63 62

	
64 63
    ///The type of the map that indicates which nodes are processed.
65 64

	
66 65
    ///The type of the map that indicates which nodes are processed.
67 66
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
68
    ///By default it is a NullMap.
69 67
    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
70 68
    ///Instantiates a \ref ProcessedMap.
71 69

	
72 70
    ///This function instantiates a \ref ProcessedMap.
73 71
    ///\param g is the digraph, to which
74 72
    ///we would like to define the \ref ProcessedMap
75 73
#ifdef DOXYGEN
76 74
    static ProcessedMap *createProcessedMap(const Digraph &g)
77 75
#else
78 76
    static ProcessedMap *createProcessedMap(const Digraph &)
79 77
#endif
80 78
    {
81 79
      return new ProcessedMap();
82 80
    }
83 81

	
84 82
    ///The type of the map that indicates which nodes are reached.
85 83

	
86 84
    ///The type of the map that indicates which nodes are reached.
87 85
    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
88 86
    typedef typename Digraph::template NodeMap<bool> ReachedMap;
89 87
    ///Instantiates a \ref ReachedMap.
90 88

	
91 89
    ///This function instantiates a \ref ReachedMap.
92 90
    ///\param g is the digraph, to which
93 91
    ///we would like to define the \ref ReachedMap.
94 92
    static ReachedMap *createReachedMap(const Digraph &g)
95 93
    {
96 94
      return new ReachedMap(g);
97 95
    }
98 96

	
99 97
    ///The type of the map that stores the distances of the nodes.
100 98

	
101 99
    ///The type of the map that stores the distances of the nodes.
102 100
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
103 101
    typedef typename Digraph::template NodeMap<int> DistMap;
104 102
    ///Instantiates a \ref DistMap.
105 103

	
106 104
    ///This function instantiates a \ref DistMap.
107 105
    ///\param g is the digraph, to which we would like to define the
108 106
    ///\ref DistMap.
109 107
    static DistMap *createDistMap(const Digraph &g)
110 108
    {
111 109
      return new DistMap(g);
112 110
    }
113 111
  };
114 112

	
115 113
  ///%DFS algorithm class.
116 114

	
117 115
  ///\ingroup search
118 116
  ///This class provides an efficient implementation of the %DFS algorithm.
119 117
  ///
120 118
  ///There is also a \ref dfs() "function-type interface" for the DFS
121 119
  ///algorithm, which is convenient in the simplier cases and it can be
122 120
  ///used easier.
123 121
  ///
124 122
  ///\tparam GR The type of the digraph the algorithm runs on.
125 123
  ///The default value is \ref ListDigraph. The value of GR is not used
126 124
  ///directly by \ref Dfs, it is only passed to \ref DfsDefaultTraits.
127 125
  ///\tparam TR Traits class to set various data types used by the algorithm.
128 126
  ///The default traits class is
129 127
  ///\ref DfsDefaultTraits "DfsDefaultTraits<GR>".
130 128
  ///See \ref DfsDefaultTraits for the documentation of
131 129
  ///a Dfs traits class.
132 130
#ifdef DOXYGEN
133 131
  template <typename GR,
134 132
            typename TR>
135 133
#else
136 134
  template <typename GR=ListDigraph,
137 135
            typename TR=DfsDefaultTraits<GR> >
138 136
#endif
139 137
  class Dfs {
140 138
  public:
141 139
    ///\ref Exception for uninitialized parameters.
142 140

	
143 141
    ///This error represents problems in the initialization of the
144 142
    ///parameters of the algorithm.
145 143
    class UninitializedParameter : public lemon::UninitializedParameter {
146 144
    public:
147 145
      virtual const char* what() const throw() {
148 146
        return "lemon::Dfs::UninitializedParameter";
149 147
      }
150 148
    };
151 149

	
152 150
    ///The type of the digraph the algorithm runs on.
153 151
    typedef typename TR::Digraph Digraph;
154 152

	
155 153
    ///\brief The type of the map that stores the predecessor arcs of the
156 154
    ///DFS paths.
157 155
    typedef typename TR::PredMap PredMap;
158 156
    ///The type of the map that stores the distances of the nodes.
159 157
    typedef typename TR::DistMap DistMap;
160 158
    ///The type of the map that indicates which nodes are reached.
161 159
    typedef typename TR::ReachedMap ReachedMap;
162 160
    ///The type of the map that indicates which nodes are processed.
163 161
    typedef typename TR::ProcessedMap ProcessedMap;
164 162
    ///The type of the paths.
165 163
    typedef PredMapPath<Digraph, PredMap> Path;
166 164

	
167 165
    ///The traits class.
168 166
    typedef TR Traits;
169 167

	
170 168
  private:
171 169

	
172 170
    typedef typename Digraph::Node Node;
173 171
    typedef typename Digraph::NodeIt NodeIt;
174 172
    typedef typename Digraph::Arc Arc;
175 173
    typedef typename Digraph::OutArcIt OutArcIt;
176 174

	
177 175
    //Pointer to the underlying digraph.
178 176
    const Digraph *G;
179 177
    //Pointer to the map of predecessor arcs.
180 178
    PredMap *_pred;
181 179
    //Indicates if _pred is locally allocated (true) or not.
182 180
    bool local_pred;
183 181
    //Pointer to the map of distances.
184 182
    DistMap *_dist;
185 183
    //Indicates if _dist is locally allocated (true) or not.
186 184
    bool local_dist;
187 185
    //Pointer to the map of reached status of the nodes.
188 186
    ReachedMap *_reached;
189 187
    //Indicates if _reached is locally allocated (true) or not.
190 188
    bool local_reached;
191 189
    //Pointer to the map of processed status of the nodes.
192 190
    ProcessedMap *_processed;
193 191
    //Indicates if _processed is locally allocated (true) or not.
194 192
    bool local_processed;
195 193

	
196 194
    std::vector<typename Digraph::OutArcIt> _stack;
197 195
    int _stack_head;
198 196

	
199
    ///Creates the maps if necessary.
200
    ///\todo Better memory allocation (instead of new).
197
    //Creates the maps if necessary.
201 198
    void create_maps()
202 199
    {
203 200
      if(!_pred) {
204 201
        local_pred = true;
205 202
        _pred = Traits::createPredMap(*G);
206 203
      }
207 204
      if(!_dist) {
208 205
        local_dist = true;
209 206
        _dist = Traits::createDistMap(*G);
210 207
      }
211 208
      if(!_reached) {
212 209
        local_reached = true;
213 210
        _reached = Traits::createReachedMap(*G);
214 211
      }
215 212
      if(!_processed) {
216 213
        local_processed = true;
217 214
        _processed = Traits::createProcessedMap(*G);
218 215
      }
219 216
    }
220 217

	
221 218
  protected:
222 219

	
223 220
    Dfs() {}
224 221

	
225 222
  public:
226 223

	
227 224
    typedef Dfs Create;
228 225

	
229 226
    ///\name Named template parameters
230 227

	
231 228
    ///@{
232 229

	
233 230
    template <class T>
234 231
    struct SetPredMapTraits : public Traits {
235 232
      typedef T PredMap;
236 233
      static PredMap *createPredMap(const Digraph &)
237 234
      {
238 235
        throw UninitializedParameter();
239 236
      }
240 237
    };
241 238
    ///\brief \ref named-templ-param "Named parameter" for setting
242 239
    ///\ref PredMap type.
243 240
    ///
244 241
    ///\ref named-templ-param "Named parameter" for setting
245 242
    ///\ref PredMap type.
246 243
    template <class T>
247 244
    struct SetPredMap : public Dfs<Digraph, SetPredMapTraits<T> > {
248 245
      typedef Dfs<Digraph, SetPredMapTraits<T> > Create;
249 246
    };
250 247

	
251 248
    template <class T>
252 249
    struct SetDistMapTraits : public Traits {
253 250
      typedef T DistMap;
254 251
      static DistMap *createDistMap(const Digraph &)
255 252
      {
256 253
        throw UninitializedParameter();
257 254
      }
258 255
    };
259 256
    ///\brief \ref named-templ-param "Named parameter" for setting
260 257
    ///\ref DistMap type.
261 258
    ///
262 259
    ///\ref named-templ-param "Named parameter" for setting
263 260
    ///\ref DistMap type.
264 261
    template <class T>
265 262
    struct SetDistMap : public Dfs< Digraph, SetDistMapTraits<T> > {
266 263
      typedef Dfs<Digraph, SetDistMapTraits<T> > Create;
267 264
    };
268 265

	
269 266
    template <class T>
270 267
    struct SetReachedMapTraits : public Traits {
271 268
      typedef T ReachedMap;
272 269
      static ReachedMap *createReachedMap(const Digraph &)
273 270
      {
274 271
        throw UninitializedParameter();
275 272
      }
276 273
    };
277 274
    ///\brief \ref named-templ-param "Named parameter" for setting
278 275
    ///\ref ReachedMap type.
279 276
    ///
280 277
    ///\ref named-templ-param "Named parameter" for setting
281 278
    ///\ref ReachedMap type.
282 279
    template <class T>
283 280
    struct SetReachedMap : public Dfs< Digraph, SetReachedMapTraits<T> > {
284 281
      typedef Dfs< Digraph, SetReachedMapTraits<T> > Create;
285 282
    };
286 283

	
287 284
    template <class T>
288 285
    struct SetProcessedMapTraits : public Traits {
289 286
      typedef T ProcessedMap;
290 287
      static ProcessedMap *createProcessedMap(const Digraph &)
291 288
      {
292 289
        throw UninitializedParameter();
293 290
      }
294 291
    };
295 292
    ///\brief \ref named-templ-param "Named parameter" for setting
296 293
    ///\ref ProcessedMap type.
297 294
    ///
298 295
    ///\ref named-templ-param "Named parameter" for setting
299 296
    ///\ref ProcessedMap type.
300 297
    template <class T>
301 298
    struct SetProcessedMap : public Dfs< Digraph, SetProcessedMapTraits<T> > {
302 299
      typedef Dfs< Digraph, SetProcessedMapTraits<T> > Create;
303 300
    };
304 301

	
305 302
    struct SetStandardProcessedMapTraits : public Traits {
306 303
      typedef typename Digraph::template NodeMap<bool> ProcessedMap;
307 304
      static ProcessedMap *createProcessedMap(const Digraph &g)
308 305
      {
309 306
        return new ProcessedMap(g);
310 307
      }
311 308
    };
312 309
    ///\brief \ref named-templ-param "Named parameter" for setting
313 310
    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
314 311
    ///
315 312
    ///\ref named-templ-param "Named parameter" for setting
316 313
    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
317 314
    ///If you don't set it explicitly, it will be automatically allocated.
318 315
    struct SetStandardProcessedMap :
319 316
      public Dfs< Digraph, SetStandardProcessedMapTraits > {
320 317
      typedef Dfs< Digraph, SetStandardProcessedMapTraits > Create;
321 318
    };
322 319

	
323 320
    ///@}
324 321

	
325 322
  public:
326 323

	
327 324
    ///Constructor.
328 325

	
329 326
    ///Constructor.
330 327
    ///\param g The digraph the algorithm runs on.
331 328
    Dfs(const Digraph &g) :
332 329
      G(&g),
333 330
      _pred(NULL), local_pred(false),
334 331
      _dist(NULL), local_dist(false),
335 332
      _reached(NULL), local_reached(false),
336 333
      _processed(NULL), local_processed(false)
337 334
    { }
338 335

	
339 336
    ///Destructor.
340 337
    ~Dfs()
341 338
    {
342 339
      if(local_pred) delete _pred;
343 340
      if(local_dist) delete _dist;
344 341
      if(local_reached) delete _reached;
345 342
      if(local_processed) delete _processed;
346 343
    }
347 344

	
348 345
    ///Sets the map that stores the predecessor arcs.
349 346

	
350 347
    ///Sets the map that stores the predecessor arcs.
351 348
    ///If you don't use this function before calling \ref run(),
352 349
    ///it will allocate one. The destructor deallocates this
353 350
    ///automatically allocated map, of course.
354 351
    ///\return <tt> (*this) </tt>
355 352
    Dfs &predMap(PredMap &m)
356 353
    {
357 354
      if(local_pred) {
358 355
        delete _pred;
359 356
        local_pred=false;
360 357
      }
361 358
      _pred = &m;
362 359
      return *this;
363 360
    }
364 361

	
365 362
    ///Sets the map that indicates which nodes are reached.
366 363

	
367 364
    ///Sets the map that indicates which nodes are reached.
368 365
    ///If you don't use this function before calling \ref run(),
369 366
    ///it will allocate one. The destructor deallocates this
370 367
    ///automatically allocated map, of course.
371 368
    ///\return <tt> (*this) </tt>
372 369
    Dfs &reachedMap(ReachedMap &m)
373 370
    {
374 371
      if(local_reached) {
375 372
        delete _reached;
376 373
        local_reached=false;
377 374
      }
378 375
      _reached = &m;
379 376
      return *this;
380 377
    }
381 378

	
382 379
    ///Sets the map that indicates which nodes are processed.
383 380

	
384 381
    ///Sets the map that indicates which nodes are processed.
385 382
    ///If you don't use this function before calling \ref run(),
386 383
    ///it will allocate one. The destructor deallocates this
387 384
    ///automatically allocated map, of course.
388 385
    ///\return <tt> (*this) </tt>
389 386
    Dfs &processedMap(ProcessedMap &m)
390 387
    {
391 388
      if(local_processed) {
392 389
        delete _processed;
393 390
        local_processed=false;
394 391
      }
395 392
      _processed = &m;
396 393
      return *this;
397 394
    }
398 395

	
399 396
    ///Sets the map that stores the distances of the nodes.
400 397

	
401 398
    ///Sets the map that stores the distances of the nodes calculated by
402 399
    ///the algorithm.
403 400
    ///If you don't use this function before calling \ref run(),
404 401
    ///it will allocate one. The destructor deallocates this
405 402
    ///automatically allocated map, of course.
406 403
    ///\return <tt> (*this) </tt>
407 404
    Dfs &distMap(DistMap &m)
408 405
    {
409 406
      if(local_dist) {
410 407
        delete _dist;
411 408
        local_dist=false;
412 409
      }
413 410
      _dist = &m;
414 411
      return *this;
415 412
    }
416 413

	
417 414
  public:
418 415

	
419 416
    ///\name Execution control
420 417
    ///The simplest way to execute the algorithm is to use
421 418
    ///one of the member functions called \ref lemon::Dfs::run() "run()".
422 419
    ///\n
423 420
    ///If you need more control on the execution, first you must call
424 421
    ///\ref lemon::Dfs::init() "init()", then you can add a source node
425 422
    ///with \ref lemon::Dfs::addSource() "addSource()".
426 423
    ///Finally \ref lemon::Dfs::start() "start()" will perform the
427 424
    ///actual path computation.
428 425

	
429 426
    ///@{
430 427

	
431 428
    ///Initializes the internal data structures.
432 429

	
433 430
    ///Initializes the internal data structures.
434 431
    ///
435 432
    void init()
436 433
    {
437 434
      create_maps();
438 435
      _stack.resize(countNodes(*G));
439 436
      _stack_head=-1;
440 437
      for ( NodeIt u(*G) ; u!=INVALID ; ++u ) {
441 438
        _pred->set(u,INVALID);
442 439
        _reached->set(u,false);
443 440
        _processed->set(u,false);
444 441
      }
445 442
    }
446 443

	
447 444
    ///Adds a new source node.
448 445

	
449 446
    ///Adds a new source node to the set of nodes to be processed.
450 447
    ///
451 448
    ///\pre The stack must be empty. (Otherwise the algorithm gives
452 449
    ///false results.)
453 450
    ///
454 451
    ///\warning Distances will be wrong (or at least strange) in case of
455 452
    ///multiple sources.
456 453
    void addSource(Node s)
457 454
    {
458 455
      LEMON_DEBUG(emptyQueue(), "The stack is not empty.");
459 456
      if(!(*_reached)[s])
460 457
        {
461 458
          _reached->set(s,true);
462 459
          _pred->set(s,INVALID);
463 460
          OutArcIt e(*G,s);
464 461
          if(e!=INVALID) {
465 462
            _stack[++_stack_head]=e;
466 463
            _dist->set(s,_stack_head);
467 464
          }
468 465
          else {
469 466
            _processed->set(s,true);
470 467
            _dist->set(s,0);
471 468
          }
472 469
        }
473 470
    }
474 471

	
475 472
    ///Processes the next arc.
476 473

	
477 474
    ///Processes the next arc.
478 475
    ///
479 476
    ///\return The processed arc.
480 477
    ///
481 478
    ///\pre The stack must not be empty.
482 479
    Arc processNextArc()
483 480
    {
484 481
      Node m;
485 482
      Arc e=_stack[_stack_head];
486 483
      if(!(*_reached)[m=G->target(e)]) {
487 484
        _pred->set(m,e);
488 485
        _reached->set(m,true);
489 486
        ++_stack_head;
490 487
        _stack[_stack_head] = OutArcIt(*G, m);
491 488
        _dist->set(m,_stack_head);
492 489
      }
493 490
      else {
494 491
        m=G->source(e);
495 492
        ++_stack[_stack_head];
496 493
      }
497 494
      while(_stack_head>=0 && _stack[_stack_head]==INVALID) {
498 495
        _processed->set(m,true);
499 496
        --_stack_head;
500 497
        if(_stack_head>=0) {
501 498
          m=G->source(_stack[_stack_head]);
502 499
          ++_stack[_stack_head];
503 500
        }
504 501
      }
505 502
      return e;
506 503
    }
507 504

	
508 505
    ///Next arc to be processed.
509 506

	
510 507
    ///Next arc to be processed.
511 508
    ///
512 509
    ///\return The next arc to be processed or \c INVALID if the stack
513 510
    ///is empty.
514 511
    OutArcIt nextArc() const
515 512
    {
516 513
      return _stack_head>=0?_stack[_stack_head]:INVALID;
517 514
    }
518 515

	
519 516
    ///\brief Returns \c false if there are nodes
520 517
    ///to be processed.
521 518
    ///
522 519
    ///Returns \c false if there are nodes
523 520
    ///to be processed in the queue (stack).
524 521
    bool emptyQueue() const { return _stack_head<0; }
525 522

	
526 523
    ///Returns the number of the nodes to be processed.
527 524

	
528 525
    ///Returns the number of the nodes to be processed in the queue (stack).
529 526
    int queueSize() const { return _stack_head+1; }
530 527

	
531 528
    ///Executes the algorithm.
532 529

	
533 530
    ///Executes the algorithm.
534 531
    ///
535 532
    ///This method runs the %DFS algorithm from the root node
536 533
    ///in order to compute the DFS path to each node.
537 534
    ///
538 535
    /// The algorithm computes
539 536
    ///- the %DFS tree,
540 537
    ///- the distance of each node from the root in the %DFS tree.
541 538
    ///
542 539
    ///\pre init() must be called and a root node should be
543 540
    ///added with addSource() before using this function.
544 541
    ///
545 542
    ///\note <tt>d.start()</tt> is just a shortcut of the following code.
546 543
    ///\code
547 544
    ///  while ( !d.emptyQueue() ) {
548 545
    ///    d.processNextArc();
549 546
    ///  }
550 547
    ///\endcode
551 548
    void start()
552 549
    {
553 550
      while ( !emptyQueue() ) processNextArc();
554 551
    }
555 552

	
556 553
    ///Executes the algorithm until the given target node is reached.
557 554

	
558 555
    ///Executes the algorithm until the given target node is reached.
559 556
    ///
560 557
    ///This method runs the %DFS algorithm from the root node
561 558
    ///in order to compute the DFS path to \c dest.
562 559
    ///
563 560
    ///The algorithm computes
564 561
    ///- the %DFS path to \c dest,
565 562
    ///- the distance of \c dest from the root in the %DFS tree.
566 563
    ///
567 564
    ///\pre init() must be called and a root node should be
568 565
    ///added with addSource() before using this function.
569 566
    void start(Node dest)
570 567
    {
571 568
      while ( !emptyQueue() && G->target(_stack[_stack_head])!=dest )
572 569
        processNextArc();
573 570
    }
574 571

	
575 572
    ///Executes the algorithm until a condition is met.
576 573

	
577 574
    ///Executes the algorithm until a condition is met.
578 575
    ///
579 576
    ///This method runs the %DFS algorithm from the root node
580 577
    ///until an arc \c a with <tt>am[a]</tt> true is found.
581 578
    ///
582 579
    ///\param am A \c bool (or convertible) arc map. The algorithm
583 580
    ///will stop when it reaches an arc \c a with <tt>am[a]</tt> true.
584 581
    ///
585 582
    ///\return The reached arc \c a with <tt>am[a]</tt> true or
586 583
    ///\c INVALID if no such arc was found.
587 584
    ///
588 585
    ///\pre init() must be called and a root node should be
589 586
    ///added with addSource() before using this function.
590 587
    ///
591 588
    ///\warning Contrary to \ref Bfs and \ref Dijkstra, \c am is an arc map,
592 589
    ///not a node map.
593 590
    template<class ArcBoolMap>
594 591
    Arc start(const ArcBoolMap &am)
595 592
    {
596 593
      while ( !emptyQueue() && !am[_stack[_stack_head]] )
597 594
        processNextArc();
598 595
      return emptyQueue() ? INVALID : _stack[_stack_head];
599 596
    }
600 597

	
601 598
    ///Runs the algorithm from the given node.
602 599

	
603 600
    ///This method runs the %DFS algorithm from node \c s
604 601
    ///in order to compute the DFS path to each node.
605 602
    ///
606 603
    ///The algorithm computes
607 604
    ///- the %DFS tree,
608 605
    ///- the distance of each node from the root in the %DFS tree.
609 606
    ///
610 607
    ///\note <tt>d.run(s)</tt> is just a shortcut of the following code.
611 608
    ///\code
612 609
    ///  d.init();
613 610
    ///  d.addSource(s);
614 611
    ///  d.start();
615 612
    ///\endcode
616 613
    void run(Node s) {
617 614
      init();
618 615
      addSource(s);
619 616
      start();
620 617
    }
621 618

	
622 619
    ///Finds the %DFS path between \c s and \c t.
623 620

	
624 621
    ///This method runs the %DFS algorithm from node \c s
625 622
    ///in order to compute the DFS path to \c t.
626 623
    ///
627 624
    ///\return The length of the <tt>s</tt>--<tt>t</tt> DFS path,
628 625
    ///if \c t is reachable form \c s, \c 0 otherwise.
629 626
    ///
630 627
    ///\note Apart from the return value, <tt>d.run(s,t)</tt> is
631 628
    ///just a shortcut of the following code.
632 629
    ///\code
633 630
    ///  d.init();
634 631
    ///  d.addSource(s);
635 632
    ///  d.start(t);
636 633
    ///\endcode
637 634
    int run(Node s,Node t) {
638 635
      init();
639 636
      addSource(s);
640 637
      start(t);
641 638
      return reached(t)?_stack_head+1:0;
642 639
    }
643 640

	
644 641
    ///Runs the algorithm to visit all nodes in the digraph.
645 642

	
646 643
    ///This method runs the %DFS algorithm in order to compute the
647 644
    ///%DFS path to each node.
648 645
    ///
649 646
    ///The algorithm computes
650 647
    ///- the %DFS tree,
651 648
    ///- the distance of each node from the root in the %DFS tree.
652 649
    ///
653 650
    ///\note <tt>d.run()</tt> is just a shortcut of the following code.
654 651
    ///\code
655 652
    ///  d.init();
656 653
    ///  for (NodeIt n(digraph); n != INVALID; ++n) {
657 654
    ///    if (!d.reached(n)) {
658 655
    ///      d.addSource(n);
659 656
    ///      d.start();
660 657
    ///    }
661 658
    ///  }
662 659
    ///\endcode
663 660
    void run() {
664 661
      init();
665 662
      for (NodeIt it(*G); it != INVALID; ++it) {
666 663
        if (!reached(it)) {
667 664
          addSource(it);
668 665
          start();
669 666
        }
670 667
      }
671 668
    }
672 669

	
673 670
    ///@}
674 671

	
675 672
    ///\name Query Functions
676 673
    ///The result of the %DFS algorithm can be obtained using these
677 674
    ///functions.\n
678 675
    ///Either \ref lemon::Dfs::run() "run()" or \ref lemon::Dfs::start()
679 676
    ///"start()" must be called before using them.
680 677

	
681 678
    ///@{
682 679

	
683 680
    ///The DFS path to a node.
684 681

	
685 682
    ///Returns the DFS path to a node.
686 683
    ///
687 684
    ///\warning \c t should be reachable from the root.
688 685
    ///
689 686
    ///\pre Either \ref run() or \ref start() must be called before
690 687
    ///using this function.
691 688
    Path path(Node t) const { return Path(*G, *_pred, t); }
692 689

	
693 690
    ///The distance of a node from the root.
694 691

	
695 692
    ///Returns the distance of a node from the root.
696 693
    ///
697 694
    ///\warning If node \c v is not reachable from the root, then
698 695
    ///the return value of this function is undefined.
699 696
    ///
700 697
    ///\pre Either \ref run() or \ref start() must be called before
701 698
    ///using this function.
702 699
    int dist(Node v) const { return (*_dist)[v]; }
703 700

	
704 701
    ///Returns the 'previous arc' of the %DFS tree for a node.
705 702

	
706 703
    ///This function returns the 'previous arc' of the %DFS tree for the
707 704
    ///node \c v, i.e. it returns the last arc of a %DFS path from the
708 705
    ///root to \c v. It is \c INVALID
709 706
    ///if \c v is not reachable from the root(s) or if \c v is a root.
710 707
    ///
711 708
    ///The %DFS tree used here is equal to the %DFS tree used in
712 709
    ///\ref predNode().
713 710
    ///
714 711
    ///\pre Either \ref run() or \ref start() must be called before using
715 712
    ///this function.
716 713
    Arc predArc(Node v) const { return (*_pred)[v];}
717 714

	
718 715
    ///Returns the 'previous node' of the %DFS tree.
719 716

	
720 717
    ///This function returns the 'previous node' of the %DFS
721 718
    ///tree for the node \c v, i.e. it returns the last but one node
722 719
    ///from a %DFS path from the root to \c v. It is \c INVALID
723 720
    ///if \c v is not reachable from the root(s) or if \c v is a root.
724 721
    ///
725 722
    ///The %DFS tree used here is equal to the %DFS tree used in
726 723
    ///\ref predArc().
727 724
    ///
728 725
    ///\pre Either \ref run() or \ref start() must be called before
729 726
    ///using this function.
730 727
    Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:
731 728
                                  G->source((*_pred)[v]); }
732 729

	
733 730
    ///\brief Returns a const reference to the node map that stores the
734 731
    ///distances of the nodes.
735 732
    ///
736 733
    ///Returns a const reference to the node map that stores the
737 734
    ///distances of the nodes calculated by the algorithm.
738 735
    ///
739 736
    ///\pre Either \ref run() or \ref init()
740 737
    ///must be called before using this function.
741 738
    const DistMap &distMap() const { return *_dist;}
742 739

	
743 740
    ///\brief Returns a const reference to the node map that stores the
744 741
    ///predecessor arcs.
745 742
    ///
746 743
    ///Returns a const reference to the node map that stores the predecessor
747 744
    ///arcs, which form the DFS tree.
748 745
    ///
749 746
    ///\pre Either \ref run() or \ref init()
750 747
    ///must be called before using this function.
751 748
    const PredMap &predMap() const { return *_pred;}
752 749

	
753 750
    ///Checks if a node is reachable from the root(s).
754 751

	
755 752
    ///Returns \c true if \c v is reachable from the root(s).
756 753
    ///\pre Either \ref run() or \ref start()
757 754
    ///must be called before using this function.
758 755
    bool reached(Node v) const { return (*_reached)[v]; }
759 756

	
760 757
    ///@}
761 758
  };
762 759

	
763 760
  ///Default traits class of dfs() function.
764 761

	
765 762
  ///Default traits class of dfs() function.
766 763
  ///\tparam GR Digraph type.
767 764
  template<class GR>
768 765
  struct DfsWizardDefaultTraits
769 766
  {
770 767
    ///The type of the digraph the algorithm runs on.
771 768
    typedef GR Digraph;
772 769

	
773 770
    ///\brief The type of the map that stores the predecessor
774 771
    ///arcs of the %DFS paths.
775 772
    ///
776 773
    ///The type of the map that stores the predecessor
777 774
    ///arcs of the %DFS paths.
778 775
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
779 776
    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
780 777
    ///Instantiates a \ref PredMap.
781 778

	
782 779
    ///This function instantiates a \ref PredMap.
783 780
    ///\param g is the digraph, to which we would like to define the
784 781
    ///\ref PredMap.
785
    ///\todo The digraph alone may be insufficient to initialize
786 782
    static PredMap *createPredMap(const Digraph &g)
787 783
    {
788 784
      return new PredMap(g);
789 785
    }
790 786

	
791 787
    ///The type of the map that indicates which nodes are processed.
792 788

	
793 789
    ///The type of the map that indicates which nodes are processed.
794 790
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
795 791
    ///By default it is a NullMap.
796 792
    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
797 793
    ///Instantiates a \ref ProcessedMap.
798 794

	
799 795
    ///This function instantiates a \ref ProcessedMap.
800 796
    ///\param g is the digraph, to which
801 797
    ///we would like to define the \ref ProcessedMap.
802 798
#ifdef DOXYGEN
803 799
    static ProcessedMap *createProcessedMap(const Digraph &g)
804 800
#else
805 801
    static ProcessedMap *createProcessedMap(const Digraph &)
806 802
#endif
807 803
    {
808 804
      return new ProcessedMap();
809 805
    }
810 806

	
811 807
    ///The type of the map that indicates which nodes are reached.
812 808

	
813 809
    ///The type of the map that indicates which nodes are reached.
814 810
    ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
815 811
    typedef typename Digraph::template NodeMap<bool> ReachedMap;
816 812
    ///Instantiates a \ref ReachedMap.
817 813

	
818 814
    ///This function instantiates a \ref ReachedMap.
819 815
    ///\param g is the digraph, to which
820 816
    ///we would like to define the \ref ReachedMap.
821 817
    static ReachedMap *createReachedMap(const Digraph &g)
822 818
    {
823 819
      return new ReachedMap(g);
824 820
    }
825 821

	
826 822
    ///The type of the map that stores the distances of the nodes.
827 823

	
828 824
    ///The type of the map that stores the distances of the nodes.
829 825
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
830 826
    typedef typename Digraph::template NodeMap<int> DistMap;
831 827
    ///Instantiates a \ref DistMap.
832 828

	
833 829
    ///This function instantiates a \ref DistMap.
834 830
    ///\param g is the digraph, to which we would like to define
835 831
    ///the \ref DistMap
836 832
    static DistMap *createDistMap(const Digraph &g)
837 833
    {
838 834
      return new DistMap(g);
839 835
    }
840 836

	
841 837
    ///The type of the DFS paths.
842 838

	
843 839
    ///The type of the DFS paths.
844 840
    ///It must meet the \ref concepts::Path "Path" concept.
845 841
    typedef lemon::Path<Digraph> Path;
846 842
  };
847 843

	
848 844
  /// Default traits class used by \ref DfsWizard
849 845

	
850 846
  /// To make it easier to use Dfs algorithm
851 847
  /// we have created a wizard class.
852 848
  /// This \ref DfsWizard class needs default traits,
853 849
  /// as well as the \ref Dfs class.
854 850
  /// The \ref DfsWizardBase is a class to be the default traits of the
855 851
  /// \ref DfsWizard class.
856 852
  template<class GR>
857 853
  class DfsWizardBase : public DfsWizardDefaultTraits<GR>
858 854
  {
859 855

	
860 856
    typedef DfsWizardDefaultTraits<GR> Base;
861 857
  protected:
862 858
    //The type of the nodes in the digraph.
863 859
    typedef typename Base::Digraph::Node Node;
864 860

	
865 861
    //Pointer to the digraph the algorithm runs on.
866 862
    void *_g;
867 863
    //Pointer to the map of reached nodes.
868 864
    void *_reached;
869 865
    //Pointer to the map of processed nodes.
870 866
    void *_processed;
871 867
    //Pointer to the map of predecessors arcs.
872 868
    void *_pred;
873 869
    //Pointer to the map of distances.
874 870
    void *_dist;
875 871
    //Pointer to the DFS path to the target node.
876 872
    void *_path;
877 873
    //Pointer to the distance of the target node.
878 874
    int *_di;
879 875

	
880 876
    public:
881 877
    /// Constructor.
882 878

	
883 879
    /// This constructor does not require parameters, therefore it initiates
884 880
    /// all of the attributes to \c 0.
885 881
    DfsWizardBase() : _g(0), _reached(0), _processed(0), _pred(0),
886 882
                      _dist(0), _path(0), _di(0) {}
887 883

	
888 884
    /// Constructor.
889 885

	
890 886
    /// This constructor requires one parameter,
891 887
    /// others are initiated to \c 0.
892 888
    /// \param g The digraph the algorithm runs on.
893 889
    DfsWizardBase(const GR &g) :
894 890
      _g(reinterpret_cast<void*>(const_cast<GR*>(&g))),
895 891
      _reached(0), _processed(0), _pred(0), _dist(0),  _path(0), _di(0) {}
896 892

	
897 893
  };
898 894

	
899 895
  /// Auxiliary class for the function-type interface of DFS algorithm.
900 896

	
901 897
  /// This auxiliary class is created to implement the
902 898
  /// \ref dfs() "function-type interface" of \ref Dfs algorithm.
903 899
  /// It does not have own \ref run() method, it uses the functions
904 900
  /// and features of the plain \ref Dfs.
905 901
  ///
906 902
  /// This class should only be used through the \ref dfs() function,
907 903
  /// which makes it easier to use the algorithm.
908 904
  template<class TR>
909 905
  class DfsWizard : public TR
910 906
  {
911 907
    typedef TR Base;
912 908

	
913 909
    ///The type of the digraph the algorithm runs on.
914 910
    typedef typename TR::Digraph Digraph;
915 911

	
916 912
    typedef typename Digraph::Node Node;
917 913
    typedef typename Digraph::NodeIt NodeIt;
918 914
    typedef typename Digraph::Arc Arc;
919 915
    typedef typename Digraph::OutArcIt OutArcIt;
920 916

	
921 917
    ///\brief The type of the map that stores the predecessor
922 918
    ///arcs of the DFS paths.
923 919
    typedef typename TR::PredMap PredMap;
924 920
    ///\brief The type of the map that stores the distances of the nodes.
925 921
    typedef typename TR::DistMap DistMap;
926 922
    ///\brief The type of the map that indicates which nodes are reached.
927 923
    typedef typename TR::ReachedMap ReachedMap;
928 924
    ///\brief The type of the map that indicates which nodes are processed.
929 925
    typedef typename TR::ProcessedMap ProcessedMap;
930 926
    ///The type of the DFS paths
931 927
    typedef typename TR::Path Path;
932 928

	
933 929
  public:
934 930

	
935 931
    /// Constructor.
936 932
    DfsWizard() : TR() {}
937 933

	
938 934
    /// Constructor that requires parameters.
939 935

	
940 936
    /// Constructor that requires parameters.
941 937
    /// These parameters will be the default values for the traits class.
942 938
    /// \param g The digraph the algorithm runs on.
943 939
    DfsWizard(const Digraph &g) :
944 940
      TR(g) {}
945 941

	
946 942
    ///Copy constructor
947 943
    DfsWizard(const TR &b) : TR(b) {}
948 944

	
949 945
    ~DfsWizard() {}
950 946

	
951 947
    ///Runs DFS algorithm from the given source node.
952 948

	
953 949
    ///This method runs DFS algorithm from node \c s
954 950
    ///in order to compute the DFS path to each node.
955 951
    void run(Node s)
956 952
    {
957 953
      Dfs<Digraph,TR> alg(*reinterpret_cast<const Digraph*>(Base::_g));
958 954
      if (Base::_pred)
959 955
        alg.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
960 956
      if (Base::_dist)
961 957
        alg.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
962 958
      if (Base::_reached)
963 959
        alg.reachedMap(*reinterpret_cast<ReachedMap*>(Base::_reached));
964 960
      if (Base::_processed)
965 961
        alg.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));
966 962
      if (s!=INVALID)
967 963
        alg.run(s);
968 964
      else
969 965
        alg.run();
970 966
    }
971 967

	
972 968
    ///Finds the DFS path between \c s and \c t.
973 969

	
974 970
    ///This method runs DFS algorithm from node \c s
975 971
    ///in order to compute the DFS path to node \c t
976 972
    ///(it stops searching when \c t is processed).
977 973
    ///
978 974
    ///\return \c true if \c t is reachable form \c s.
979 975
    bool run(Node s, Node t)
980 976
    {
981 977
      if (s==INVALID || t==INVALID) throw UninitializedParameter();
982 978
      Dfs<Digraph,TR> alg(*reinterpret_cast<const Digraph*>(Base::_g));
983 979
      if (Base::_pred)
984 980
        alg.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
985 981
      if (Base::_dist)
986 982
        alg.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
987 983
      if (Base::_reached)
988 984
        alg.reachedMap(*reinterpret_cast<ReachedMap*>(Base::_reached));
989 985
      if (Base::_processed)
990 986
        alg.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));
991 987
      alg.run(s,t);
992 988
      if (Base::_path)
993 989
        *reinterpret_cast<Path*>(Base::_path) = alg.path(t);
994 990
      if (Base::_di)
995 991
        *Base::_di = alg.dist(t);
996 992
      return alg.reached(t);
997 993
      }
998 994

	
999 995
    ///Runs DFS algorithm to visit all nodes in the digraph.
1000 996

	
1001 997
    ///This method runs DFS algorithm in order to compute
1002 998
    ///the DFS path to each node.
1003 999
    void run()
1004 1000
    {
1005 1001
      run(INVALID);
1006 1002
    }
1007 1003

	
1008 1004
    template<class T>
1009 1005
    struct SetPredMapBase : public Base {
1010 1006
      typedef T PredMap;
1011 1007
      static PredMap *createPredMap(const Digraph &) { return 0; };
1012 1008
      SetPredMapBase(const TR &b) : TR(b) {}
1013 1009
    };
1014 1010
    ///\brief \ref named-func-param "Named parameter"
1015 1011
    ///for setting \ref PredMap object.
1016 1012
    ///
1017 1013
    ///\ref named-func-param "Named parameter"
1018 1014
    ///for setting \ref PredMap object.
1019 1015
    template<class T>
1020 1016
    DfsWizard<SetPredMapBase<T> > predMap(const T &t)
1021 1017
    {
1022 1018
      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));
1023 1019
      return DfsWizard<SetPredMapBase<T> >(*this);
1024 1020
    }
1025 1021

	
1026 1022
    template<class T>
1027 1023
    struct SetReachedMapBase : public Base {
1028 1024
      typedef T ReachedMap;
1029 1025
      static ReachedMap *createReachedMap(const Digraph &) { return 0; };
1030 1026
      SetReachedMapBase(const TR &b) : TR(b) {}
1031 1027
    };
1032 1028
    ///\brief \ref named-func-param "Named parameter"
1033 1029
    ///for setting \ref ReachedMap object.
1034 1030
    ///
1035 1031
    /// \ref named-func-param "Named parameter"
1036 1032
    ///for setting \ref ReachedMap object.
1037 1033
    template<class T>
1038 1034
    DfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
1039 1035
    {
1040 1036
      Base::_reached=reinterpret_cast<void*>(const_cast<T*>(&t));
1041 1037
      return DfsWizard<SetReachedMapBase<T> >(*this);
1042 1038
    }
1043 1039

	
1044 1040
    template<class T>
1045 1041
    struct SetDistMapBase : public Base {
1046 1042
      typedef T DistMap;
1047 1043
      static DistMap *createDistMap(const Digraph &) { return 0; };
1048 1044
      SetDistMapBase(const TR &b) : TR(b) {}
1049 1045
    };
1050 1046
    ///\brief \ref named-func-param "Named parameter"
1051 1047
    ///for setting \ref DistMap object.
1052 1048
    ///
1053 1049
    /// \ref named-func-param "Named parameter"
1054 1050
    ///for setting \ref DistMap object.
1055 1051
    template<class T>
1056 1052
    DfsWizard<SetDistMapBase<T> > distMap(const T &t)
1057 1053
    {
1058 1054
      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));
1059 1055
      return DfsWizard<SetDistMapBase<T> >(*this);
1060 1056
    }
1061 1057

	
1062 1058
    template<class T>
1063 1059
    struct SetProcessedMapBase : public Base {
1064 1060
      typedef T ProcessedMap;
1065 1061
      static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
1066 1062
      SetProcessedMapBase(const TR &b) : TR(b) {}
1067 1063
    };
1068 1064
    ///\brief \ref named-func-param "Named parameter"
1069 1065
    ///for setting \ref ProcessedMap object.
1070 1066
    ///
1071 1067
    /// \ref named-func-param "Named parameter"
1072 1068
    ///for setting \ref ProcessedMap object.
1073 1069
    template<class T>
1074 1070
    DfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
1075 1071
    {
1076 1072
      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));
1077 1073
      return DfsWizard<SetProcessedMapBase<T> >(*this);
1078 1074
    }
1079 1075

	
1080 1076
    template<class T>
1081 1077
    struct SetPathBase : public Base {
1082 1078
      typedef T Path;
1083 1079
      SetPathBase(const TR &b) : TR(b) {}
1084 1080
    };
1085 1081
    ///\brief \ref named-func-param "Named parameter"
1086 1082
    ///for getting the DFS path to the target node.
1087 1083
    ///
1088 1084
    ///\ref named-func-param "Named parameter"
1089 1085
    ///for getting the DFS path to the target node.
1090 1086
    template<class T>
1091 1087
    DfsWizard<SetPathBase<T> > path(const T &t)
1092 1088
    {
1093 1089
      Base::_path=reinterpret_cast<void*>(const_cast<T*>(&t));
1094 1090
      return DfsWizard<SetPathBase<T> >(*this);
1095 1091
    }
1096 1092

	
1097 1093
    ///\brief \ref named-func-param "Named parameter"
1098 1094
    ///for getting the distance of the target node.
1099 1095
    ///
1100 1096
    ///\ref named-func-param "Named parameter"
1101 1097
    ///for getting the distance of the target node.
1102 1098
    DfsWizard dist(const int &d)
1103 1099
    {
1104 1100
      Base::_di=const_cast<int*>(&d);
1105 1101
      return *this;
1106 1102
    }
1107 1103

	
1108 1104
  };
1109 1105

	
1110 1106
  ///Function-type interface for DFS algorithm.
1111 1107

	
1112 1108
  ///\ingroup search
1113 1109
  ///Function-type interface for DFS algorithm.
1114 1110
  ///
1115 1111
  ///This function also has several \ref named-func-param "named parameters",
1116 1112
  ///they are declared as the members of class \ref DfsWizard.
1117 1113
  ///The following examples show how to use these parameters.
1118 1114
  ///\code
1119 1115
  ///  // Compute the DFS tree
1120 1116
  ///  dfs(g).predMap(preds).distMap(dists).run(s);
1121 1117
  ///
1122 1118
  ///  // Compute the DFS path from s to t
1123 1119
  ///  bool reached = dfs(g).path(p).dist(d).run(s,t);
1124 1120
  ///\endcode
1125 1121

	
1126 1122
  ///\warning Don't forget to put the \ref DfsWizard::run() "run()"
1127 1123
  ///to the end of the parameter list.
1128 1124
  ///\sa DfsWizard
1129 1125
  ///\sa Dfs
1130 1126
  template<class GR>
1131 1127
  DfsWizard<DfsWizardBase<GR> >
1132 1128
  dfs(const GR &digraph)
1133 1129
  {
1134 1130
    return DfsWizard<DfsWizardBase<GR> >(digraph);
1135 1131
  }
1136 1132

	
1137 1133
#ifdef DOXYGEN
1138 1134
  /// \brief Visitor class for DFS.
1139 1135
  ///
1140 1136
  /// This class defines the interface of the DfsVisit events, and
1141 1137
  /// it could be the base of a real visitor class.
1142 1138
  template <typename _Digraph>
1143 1139
  struct DfsVisitor {
1144 1140
    typedef _Digraph Digraph;
1145 1141
    typedef typename Digraph::Arc Arc;
1146 1142
    typedef typename Digraph::Node Node;
1147 1143
    /// \brief Called for the source node of the DFS.
1148 1144
    ///
1149 1145
    /// This function is called for the source node of the DFS.
1150 1146
    void start(const Node& node) {}
1151 1147
    /// \brief Called when the source node is leaved.
1152 1148
    ///
1153 1149
    /// This function is called when the source node is leaved.
1154 1150
    void stop(const Node& node) {}
1155 1151
    /// \brief Called when a node is reached first time.
1156 1152
    ///
1157 1153
    /// This function is called when a node is reached first time.
1158 1154
    void reach(const Node& node) {}
1159 1155
    /// \brief Called when an arc reaches a new node.
1160 1156
    ///
1161 1157
    /// This function is called when the DFS finds an arc whose target node
1162 1158
    /// is not reached yet.
1163 1159
    void discover(const Arc& arc) {}
1164 1160
    /// \brief Called when an arc is examined but its target node is
1165 1161
    /// already discovered.
1166 1162
    ///
1167 1163
    /// This function is called when an arc is examined but its target node is
1168 1164
    /// already discovered.
1169 1165
    void examine(const Arc& arc) {}
1170 1166
    /// \brief Called when the DFS steps back from a node.
1171 1167
    ///
1172 1168
    /// This function is called when the DFS steps back from a node.
1173 1169
    void leave(const Node& node) {}
1174 1170
    /// \brief Called when the DFS steps back on an arc.
1175 1171
    ///
1176 1172
    /// This function is called when the DFS steps back on an arc.
1177 1173
    void backtrack(const Arc& arc) {}
1178 1174
  };
1179 1175
#else
1180 1176
  template <typename _Digraph>
1181 1177
  struct DfsVisitor {
1182 1178
    typedef _Digraph Digraph;
1183 1179
    typedef typename Digraph::Arc Arc;
1184 1180
    typedef typename Digraph::Node Node;
1185 1181
    void start(const Node&) {}
1186 1182
    void stop(const Node&) {}
1187 1183
    void reach(const Node&) {}
1188 1184
    void discover(const Arc&) {}
1189 1185
    void examine(const Arc&) {}
1190 1186
    void leave(const Node&) {}
1191 1187
    void backtrack(const Arc&) {}
1192 1188

	
1193 1189
    template <typename _Visitor>
1194 1190
    struct Constraints {
1195 1191
      void constraints() {
1196 1192
        Arc arc;
1197 1193
        Node node;
1198 1194
        visitor.start(node);
1199 1195
        visitor.stop(arc);
1200 1196
        visitor.reach(node);
1201 1197
        visitor.discover(arc);
1202 1198
        visitor.examine(arc);
1203 1199
        visitor.leave(node);
1204 1200
        visitor.backtrack(arc);
1205 1201
      }
1206 1202
      _Visitor& visitor;
1207 1203
    };
1208 1204
  };
1209 1205
#endif
1210 1206

	
1211 1207
  /// \brief Default traits class of DfsVisit class.
1212 1208
  ///
1213 1209
  /// Default traits class of DfsVisit class.
1214 1210
  /// \tparam _Digraph The type of the digraph the algorithm runs on.
1215 1211
  template<class _Digraph>
1216 1212
  struct DfsVisitDefaultTraits {
1217 1213

	
1218 1214
    /// \brief The type of the digraph the algorithm runs on.
1219 1215
    typedef _Digraph Digraph;
1220 1216

	
1221 1217
    /// \brief The type of the map that indicates which nodes are reached.
1222 1218
    ///
1223 1219
    /// The type of the map that indicates which nodes are reached.
1224 1220
    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
1225 1221
    typedef typename Digraph::template NodeMap<bool> ReachedMap;
1226 1222

	
1227 1223
    /// \brief Instantiates a \ref ReachedMap.
1228 1224
    ///
1229 1225
    /// This function instantiates a \ref ReachedMap.
1230 1226
    /// \param digraph is the digraph, to which
1231 1227
    /// we would like to define the \ref ReachedMap.
1232 1228
    static ReachedMap *createReachedMap(const Digraph &digraph) {
1233 1229
      return new ReachedMap(digraph);
1234 1230
    }
1235 1231

	
1236 1232
  };
1237 1233

	
1238 1234
  /// \ingroup search
1239 1235
  ///
1240 1236
  /// \brief %DFS algorithm class with visitor interface.
1241 1237
  ///
1242 1238
  /// This class provides an efficient implementation of the %DFS algorithm
1243 1239
  /// with visitor interface.
1244 1240
  ///
1245 1241
  /// The %DfsVisit class provides an alternative interface to the Dfs
1246 1242
  /// class. It works with callback mechanism, the DfsVisit object calls
1247 1243
  /// the member functions of the \c Visitor class on every DFS event.
1248 1244
  ///
1249 1245
  /// This interface of the DFS algorithm should be used in special cases
1250 1246
  /// when extra actions have to be performed in connection with certain
1251 1247
  /// events of the DFS algorithm. Otherwise consider to use Dfs or dfs()
1252 1248
  /// instead.
1253 1249
  ///
1254 1250
  /// \tparam _Digraph The type of the digraph the algorithm runs on.
1255 1251
  /// The default value is
1256 1252
  /// \ref ListDigraph. The value of _Digraph is not used directly by
1257 1253
  /// \ref DfsVisit, it is only passed to \ref DfsVisitDefaultTraits.
1258 1254
  /// \tparam _Visitor The Visitor type that is used by the algorithm.
1259 1255
  /// \ref DfsVisitor "DfsVisitor<_Digraph>" is an empty visitor, which
1260 1256
  /// does not observe the DFS events. If you want to observe the DFS
1261 1257
  /// events, you should implement your own visitor class.
1262 1258
  /// \tparam _Traits Traits class to set various data types used by the
1263 1259
  /// algorithm. The default traits class is
1264 1260
  /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits<_Digraph>".
1265 1261
  /// See \ref DfsVisitDefaultTraits for the documentation of
1266 1262
  /// a DFS visit traits class.
1267 1263
#ifdef DOXYGEN
1268 1264
  template <typename _Digraph, typename _Visitor, typename _Traits>
1269 1265
#else
1270 1266
  template <typename _Digraph = ListDigraph,
1271 1267
            typename _Visitor = DfsVisitor<_Digraph>,
1272 1268
            typename _Traits = DfsDefaultTraits<_Digraph> >
1273 1269
#endif
1274 1270
  class DfsVisit {
1275 1271
  public:
1276 1272

	
1277 1273
    /// \brief \ref Exception for uninitialized parameters.
1278 1274
    ///
1279 1275
    /// This error represents problems in the initialization
1280 1276
    /// of the parameters of the algorithm.
1281 1277
    class UninitializedParameter : public lemon::UninitializedParameter {
1282 1278
    public:
1283 1279
      virtual const char* what() const throw()
1284 1280
      {
1285 1281
        return "lemon::DfsVisit::UninitializedParameter";
1286 1282
      }
1287 1283
    };
1288 1284

	
1289 1285
    ///The traits class.
1290 1286
    typedef _Traits Traits;
1291 1287

	
1292 1288
    ///The type of the digraph the algorithm runs on.
1293 1289
    typedef typename Traits::Digraph Digraph;
1294 1290

	
1295 1291
    ///The visitor type used by the algorithm.
1296 1292
    typedef _Visitor Visitor;
1297 1293

	
1298 1294
    ///The type of the map that indicates which nodes are reached.
1299 1295
    typedef typename Traits::ReachedMap ReachedMap;
1300 1296

	
1301 1297
  private:
1302 1298

	
1303 1299
    typedef typename Digraph::Node Node;
1304 1300
    typedef typename Digraph::NodeIt NodeIt;
1305 1301
    typedef typename Digraph::Arc Arc;
1306 1302
    typedef typename Digraph::OutArcIt OutArcIt;
1307 1303

	
1308 1304
    //Pointer to the underlying digraph.
1309 1305
    const Digraph *_digraph;
1310 1306
    //Pointer to the visitor object.
1311 1307
    Visitor *_visitor;
1312 1308
    //Pointer to the map of reached status of the nodes.
1313 1309
    ReachedMap *_reached;
1314 1310
    //Indicates if _reached is locally allocated (true) or not.
1315 1311
    bool local_reached;
1316 1312

	
1317 1313
    std::vector<typename Digraph::Arc> _stack;
1318 1314
    int _stack_head;
1319 1315

	
1320
    ///Creates the maps if necessary.
1321
    ///\todo Better memory allocation (instead of new).
1316
    //Creates the maps if necessary.
1322 1317
    void create_maps() {
1323 1318
      if(!_reached) {
1324 1319
        local_reached = true;
1325 1320
        _reached = Traits::createReachedMap(*_digraph);
1326 1321
      }
1327 1322
    }
1328 1323

	
1329 1324
  protected:
1330 1325

	
1331 1326
    DfsVisit() {}
1332 1327

	
1333 1328
  public:
1334 1329

	
1335 1330
    typedef DfsVisit Create;
1336 1331

	
1337 1332
    /// \name Named template parameters
1338 1333

	
1339 1334
    ///@{
1340 1335
    template <class T>
1341 1336
    struct SetReachedMapTraits : public Traits {
1342 1337
      typedef T ReachedMap;
1343 1338
      static ReachedMap *createReachedMap(const Digraph &digraph) {
1344 1339
        throw UninitializedParameter();
1345 1340
      }
1346 1341
    };
1347 1342
    /// \brief \ref named-templ-param "Named parameter" for setting
1348 1343
    /// ReachedMap type.
1349 1344
    ///
1350 1345
    /// \ref named-templ-param "Named parameter" for setting ReachedMap type.
1351 1346
    template <class T>
1352 1347
    struct SetReachedMap : public DfsVisit< Digraph, Visitor,
1353 1348
                                            SetReachedMapTraits<T> > {
1354 1349
      typedef DfsVisit< Digraph, Visitor, SetReachedMapTraits<T> > Create;
1355 1350
    };
1356 1351
    ///@}
1357 1352

	
1358 1353
  public:
1359 1354

	
1360 1355
    /// \brief Constructor.
1361 1356
    ///
1362 1357
    /// Constructor.
1363 1358
    ///
1364 1359
    /// \param digraph The digraph the algorithm runs on.
1365 1360
    /// \param visitor The visitor object of the algorithm.
1366 1361
    DfsVisit(const Digraph& digraph, Visitor& visitor)
1367 1362
      : _digraph(&digraph), _visitor(&visitor),
1368 1363
        _reached(0), local_reached(false) {}
1369 1364

	
1370 1365
    /// \brief Destructor.
1371 1366
    ~DfsVisit() {
1372 1367
      if(local_reached) delete _reached;
1373 1368
    }
1374 1369

	
1375 1370
    /// \brief Sets the map that indicates which nodes are reached.
1376 1371
    ///
1377 1372
    /// Sets the map that indicates which nodes are reached.
1378 1373
    /// If you don't use this function before calling \ref run(),
1379 1374
    /// it will allocate one. The destructor deallocates this
1380 1375
    /// automatically allocated map, of course.
1381 1376
    /// \return <tt> (*this) </tt>
1382 1377
    DfsVisit &reachedMap(ReachedMap &m) {
1383 1378
      if(local_reached) {
1384 1379
        delete _reached;
1385 1380
        local_reached=false;
1386 1381
      }
1387 1382
      _reached = &m;
1388 1383
      return *this;
1389 1384
    }
1390 1385

	
1391 1386
  public:
1392 1387

	
1393 1388
    /// \name Execution control
1394 1389
    /// The simplest way to execute the algorithm is to use
1395 1390
    /// one of the member functions called \ref lemon::DfsVisit::run()
1396 1391
    /// "run()".
1397 1392
    /// \n
1398 1393
    /// If you need more control on the execution, first you must call
1399 1394
    /// \ref lemon::DfsVisit::init() "init()", then you can add several
1400 1395
    /// source nodes with \ref lemon::DfsVisit::addSource() "addSource()".
1401 1396
    /// Finally \ref lemon::DfsVisit::start() "start()" will perform the
1402 1397
    /// actual path computation.
1403 1398

	
1404 1399
    /// @{
1405 1400

	
1406 1401
    /// \brief Initializes the internal data structures.
1407 1402
    ///
1408 1403
    /// Initializes the internal data structures.
1409 1404
    void init() {
1410 1405
      create_maps();
1411 1406
      _stack.resize(countNodes(*_digraph));
1412 1407
      _stack_head = -1;
1413 1408
      for (NodeIt u(*_digraph) ; u != INVALID ; ++u) {
1414 1409
        _reached->set(u, false);
1415 1410
      }
1416 1411
    }
1417 1412

	
1418 1413
    ///Adds a new source node.
1419 1414

	
1420 1415
    ///Adds a new source node to the set of nodes to be processed.
1421 1416
    ///
1422 1417
    ///\pre The stack must be empty. (Otherwise the algorithm gives
1423 1418
    ///false results.)
1424 1419
    ///
1425 1420
    ///\warning Distances will be wrong (or at least strange) in case of
1426 1421
    ///multiple sources.
1427 1422
    void addSource(Node s)
1428 1423
    {
1429 1424
      LEMON_DEBUG(emptyQueue(), "The stack is not empty.");
1430 1425
      if(!(*_reached)[s]) {
1431 1426
          _reached->set(s,true);
1432 1427
          _visitor->start(s);
1433 1428
          _visitor->reach(s);
1434 1429
          Arc e;
1435 1430
          _digraph->firstOut(e, s);
1436 1431
          if (e != INVALID) {
1437 1432
            _stack[++_stack_head] = e;
1438 1433
          } else {
1439 1434
            _visitor->leave(s);
1440 1435
          }
1441 1436
        }
1442 1437
    }
1443 1438

	
1444 1439
    /// \brief Processes the next arc.
1445 1440
    ///
1446 1441
    /// Processes the next arc.
1447 1442
    ///
1448 1443
    /// \return The processed arc.
1449 1444
    ///
1450 1445
    /// \pre The stack must not be empty.
1451 1446
    Arc processNextArc() {
1452 1447
      Arc e = _stack[_stack_head];
1453 1448
      Node m = _digraph->target(e);
1454 1449
      if(!(*_reached)[m]) {
1455 1450
        _visitor->discover(e);
1456 1451
        _visitor->reach(m);
1457 1452
        _reached->set(m, true);
1458 1453
        _digraph->firstOut(_stack[++_stack_head], m);
1459 1454
      } else {
1460 1455
        _visitor->examine(e);
1461 1456
        m = _digraph->source(e);
1462 1457
        _digraph->nextOut(_stack[_stack_head]);
1463 1458
      }
1464 1459
      while (_stack_head>=0 && _stack[_stack_head] == INVALID) {
1465 1460
        _visitor->leave(m);
1466 1461
        --_stack_head;
1467 1462
        if (_stack_head >= 0) {
1468 1463
          _visitor->backtrack(_stack[_stack_head]);
1469 1464
          m = _digraph->source(_stack[_stack_head]);
1470 1465
          _digraph->nextOut(_stack[_stack_head]);
1471 1466
        } else {
1472 1467
          _visitor->stop(m);
1473 1468
        }
1474 1469
      }
1475 1470
      return e;
1476 1471
    }
1477 1472

	
1478 1473
    /// \brief Next arc to be processed.
1479 1474
    ///
1480 1475
    /// Next arc to be processed.
1481 1476
    ///
1482 1477
    /// \return The next arc to be processed or INVALID if the stack is
1483 1478
    /// empty.
1484 1479
    Arc nextArc() const {
1485 1480
      return _stack_head >= 0 ? _stack[_stack_head] : INVALID;
1486 1481
    }
1487 1482

	
1488 1483
    /// \brief Returns \c false if there are nodes
1489 1484
    /// to be processed.
1490 1485
    ///
1491 1486
    /// Returns \c false if there are nodes
1492 1487
    /// to be processed in the queue (stack).
1493 1488
    bool emptyQueue() const { return _stack_head < 0; }
1494 1489

	
1495 1490
    /// \brief Returns the number of the nodes to be processed.
1496 1491
    ///
1497 1492
    /// Returns the number of the nodes to be processed in the queue (stack).
1498 1493
    int queueSize() const { return _stack_head + 1; }
1499 1494

	
1500 1495
    /// \brief Executes the algorithm.
1501 1496
    ///
1502 1497
    /// Executes the algorithm.
1503 1498
    ///
1504 1499
    /// This method runs the %DFS algorithm from the root node
1505 1500
    /// in order to compute the %DFS path to each node.
1506 1501
    ///
1507 1502
    /// The algorithm computes
1508 1503
    /// - the %DFS tree,
1509 1504
    /// - the distance of each node from the root in the %DFS tree.
1510 1505
    ///
1511 1506
    /// \pre init() must be called and a root node should be
1512 1507
    /// added with addSource() before using this function.
1513 1508
    ///
1514 1509
    /// \note <tt>d.start()</tt> is just a shortcut of the following code.
1515 1510
    /// \code
1516 1511
    ///   while ( !d.emptyQueue() ) {
1517 1512
    ///     d.processNextArc();
1518 1513
    ///   }
1519 1514
    /// \endcode
1520 1515
    void start() {
1521 1516
      while ( !emptyQueue() ) processNextArc();
1522 1517
    }
1523 1518

	
1524 1519
    /// \brief Executes the algorithm until the given target node is reached.
1525 1520
    ///
1526 1521
    /// Executes the algorithm until the given target node is reached.
1527 1522
    ///
1528 1523
    /// This method runs the %DFS algorithm from the root node
1529 1524
    /// in order to compute the DFS path to \c dest.
1530 1525
    ///
1531 1526
    /// The algorithm computes
1532 1527
    /// - the %DFS path to \c dest,
1533 1528
    /// - the distance of \c dest from the root in the %DFS tree.
1534 1529
    ///
1535 1530
    /// \pre init() must be called and a root node should be added
1536 1531
    /// with addSource() before using this function.
1537 1532
    void start(Node dest) {
1538 1533
      while ( !emptyQueue() && _digraph->target(_stack[_stack_head]) != dest )
1539 1534
        processNextArc();
1540 1535
    }
1541 1536

	
1542 1537
    /// \brief Executes the algorithm until a condition is met.
1543 1538
    ///
1544 1539
    /// Executes the algorithm until a condition is met.
1545 1540
    ///
1546 1541
    /// This method runs the %DFS algorithm from the root node
1547 1542
    /// until an arc \c a with <tt>am[a]</tt> true is found.
1548 1543
    ///
1549 1544
    /// \param am A \c bool (or convertible) arc map. The algorithm
1550 1545
    /// will stop when it reaches an arc \c a with <tt>am[a]</tt> true.
1551 1546
    ///
1552 1547
    /// \return The reached arc \c a with <tt>am[a]</tt> true or
1553 1548
    /// \c INVALID if no such arc was found.
1554 1549
    ///
1555 1550
    /// \pre init() must be called and a root node should be added
1556 1551
    /// with addSource() before using this function.
1557 1552
    ///
1558 1553
    /// \warning Contrary to \ref Bfs and \ref Dijkstra, \c am is an arc map,
1559 1554
    /// not a node map.
1560 1555
    template <typename AM>
1561 1556
    Arc start(const AM &am) {
1562 1557
      while ( !emptyQueue() && !am[_stack[_stack_head]] )
1563 1558
        processNextArc();
1564 1559
      return emptyQueue() ? INVALID : _stack[_stack_head];
1565 1560
    }
1566 1561

	
1567 1562
    /// \brief Runs the algorithm from the given node.
1568 1563
    ///
1569 1564
    /// This method runs the %DFS algorithm from node \c s.
1570 1565
    /// in order to compute the DFS path to each node.
1571 1566
    ///
1572 1567
    /// The algorithm computes
1573 1568
    /// - the %DFS tree,
1574 1569
    /// - the distance of each node from the root in the %DFS tree.
1575 1570
    ///
1576 1571
    /// \note <tt>d.run(s)</tt> is just a shortcut of the following code.
1577 1572
    ///\code
1578 1573
    ///   d.init();
1579 1574
    ///   d.addSource(s);
1580 1575
    ///   d.start();
1581 1576
    ///\endcode
1582 1577
    void run(Node s) {
1583 1578
      init();
1584 1579
      addSource(s);
1585 1580
      start();
1586 1581
    }
1587 1582

	
1588 1583
    /// \brief Finds the %DFS path between \c s and \c t.
1589 1584

	
1590 1585
    /// This method runs the %DFS algorithm from node \c s
1591 1586
    /// in order to compute the DFS path to \c t.
1592 1587
    ///
1593 1588
    /// \return The length of the <tt>s</tt>--<tt>t</tt> DFS path,
1594 1589
    /// if \c t is reachable form \c s, \c 0 otherwise.
1595 1590
    ///
1596 1591
    /// \note Apart from the return value, <tt>d.run(s,t)</tt> is
1597 1592
    /// just a shortcut of the following code.
1598 1593
    ///\code
1599 1594
    ///   d.init();
1600 1595
    ///   d.addSource(s);
1601 1596
    ///   d.start(t);
1602 1597
    ///\endcode
1603 1598
    int run(Node s,Node t) {
1604 1599
      init();
1605 1600
      addSource(s);
1606 1601
      start(t);
1607 1602
      return reached(t)?_stack_head+1:0;
1608 1603
    }
1609 1604

	
1610 1605
    /// \brief Runs the algorithm to visit all nodes in the digraph.
1611 1606

	
1612 1607
    /// This method runs the %DFS algorithm in order to
1613 1608
    /// compute the %DFS path to each node.
1614 1609
    ///
1615 1610
    /// The algorithm computes
1616 1611
    /// - the %DFS tree,
1617 1612
    /// - the distance of each node from the root in the %DFS tree.
1618 1613
    ///
1619 1614
    /// \note <tt>d.run()</tt> is just a shortcut of the following code.
1620 1615
    ///\code
1621 1616
    ///   d.init();
1622 1617
    ///   for (NodeIt n(digraph); n != INVALID; ++n) {
1623 1618
    ///     if (!d.reached(n)) {
1624 1619
    ///       d.addSource(n);
1625 1620
    ///       d.start();
1626 1621
    ///     }
1627 1622
    ///   }
1628 1623
    ///\endcode
1629 1624
    void run() {
1630 1625
      init();
1631 1626
      for (NodeIt it(*_digraph); it != INVALID; ++it) {
1632 1627
        if (!reached(it)) {
1633 1628
          addSource(it);
1634 1629
          start();
1635 1630
        }
1636 1631
      }
1637 1632
    }
1638 1633

	
1639 1634
    ///@}
1640 1635

	
1641 1636
    /// \name Query Functions
1642 1637
    /// The result of the %DFS algorithm can be obtained using these
1643 1638
    /// functions.\n
1644 1639
    /// Either \ref lemon::DfsVisit::run() "run()" or
1645 1640
    /// \ref lemon::DfsVisit::start() "start()" must be called before
1646 1641
    /// using them.
1647 1642
    ///@{
1648 1643

	
1649 1644
    /// \brief Checks if a node is reachable from the root(s).
1650 1645
    ///
1651 1646
    /// Returns \c true if \c v is reachable from the root(s).
1652 1647
    /// \pre Either \ref run() or \ref start()
1653 1648
    /// must be called before using this function.
1654 1649
    bool reached(Node v) { return (*_reached)[v]; }
1655 1650

	
1656 1651
    ///@}
1657 1652

	
1658 1653
  };
1659 1654

	
1660 1655
} //END OF NAMESPACE LEMON
1661 1656

	
1662 1657
#endif
Ignore white space 6 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_DIJKSTRA_H
20 20
#define LEMON_DIJKSTRA_H
21 21

	
22 22
///\ingroup shortest_path
23 23
///\file
24 24
///\brief Dijkstra algorithm.
25 25

	
26 26
#include <limits>
27 27
#include <lemon/list_graph.h>
28 28
#include <lemon/bin_heap.h>
29 29
#include <lemon/bits/path_dump.h>
30 30
#include <lemon/core.h>
31 31
#include <lemon/error.h>
32 32
#include <lemon/maps.h>
33 33
#include <lemon/path.h>
34 34

	
35 35
namespace lemon {
36 36

	
37 37
  /// \brief Default operation traits for the Dijkstra algorithm class.
38 38
  ///
39 39
  /// This operation traits class defines all computational operations and
40 40
  /// constants which are used in the Dijkstra algorithm.
41 41
  template <typename Value>
42 42
  struct DijkstraDefaultOperationTraits {
43 43
    /// \brief Gives back the zero value of the type.
44 44
    static Value zero() {
45 45
      return static_cast<Value>(0);
46 46
    }
47 47
    /// \brief Gives back the sum of the given two elements.
48 48
    static Value plus(const Value& left, const Value& right) {
49 49
      return left + right;
50 50
    }
51 51
    /// \brief Gives back true only if the first value is less than the second.
52 52
    static bool less(const Value& left, const Value& right) {
53 53
      return left < right;
54 54
    }
55 55
  };
56 56

	
57 57
  /// \brief Widest path operation traits for the Dijkstra algorithm class.
58 58
  ///
59 59
  /// This operation traits class defines all computational operations and
60 60
  /// constants which are used in the Dijkstra algorithm for widest path
61 61
  /// computation.
62 62
  ///
63 63
  /// \see DijkstraDefaultOperationTraits
64 64
  template <typename Value>
65 65
  struct DijkstraWidestPathOperationTraits {
66 66
    /// \brief Gives back the maximum value of the type.
67 67
    static Value zero() {
68 68
      return std::numeric_limits<Value>::max();
69 69
    }
70 70
    /// \brief Gives back the minimum of the given two elements.
71 71
    static Value plus(const Value& left, const Value& right) {
72 72
      return std::min(left, right);
73 73
    }
74 74
    /// \brief Gives back true only if the first value is less than the second.
75 75
    static bool less(const Value& left, const Value& right) {
76 76
      return left < right;
77 77
    }
78 78
  };
79 79

	
80 80
  ///Default traits class of Dijkstra class.
81 81

	
82 82
  ///Default traits class of Dijkstra class.
83 83
  ///\tparam GR The type of the digraph.
84 84
  ///\tparam LM The type of the length map.
85 85
  template<class GR, class LM>
86 86
  struct DijkstraDefaultTraits
87 87
  {
88 88
    ///The type of the digraph the algorithm runs on.
89 89
    typedef GR Digraph;
90 90

	
91 91
    ///The type of the map that stores the arc lengths.
92 92

	
93 93
    ///The type of the map that stores the arc lengths.
94 94
    ///It must meet the \ref concepts::ReadMap "ReadMap" concept.
95 95
    typedef LM LengthMap;
96 96
    ///The type of the length of the arcs.
97 97
    typedef typename LM::Value Value;
98 98

	
99 99
    /// Operation traits for Dijkstra algorithm.
100 100

	
101 101
    /// This class defines the operations that are used in the algorithm.
102 102
    /// \see DijkstraDefaultOperationTraits
103 103
    typedef DijkstraDefaultOperationTraits<Value> OperationTraits;
104 104

	
105 105
    /// The cross reference type used by the heap.
106 106

	
107 107
    /// The cross reference type used by the heap.
108 108
    /// Usually it is \c Digraph::NodeMap<int>.
109 109
    typedef typename Digraph::template NodeMap<int> HeapCrossRef;
110 110
    ///Instantiates a \ref HeapCrossRef.
111 111

	
112 112
    ///This function instantiates a \ref HeapCrossRef.
113 113
    /// \param g is the digraph, to which we would like to define the
114 114
    /// \ref HeapCrossRef.
115 115
    static HeapCrossRef *createHeapCrossRef(const Digraph &g)
116 116
    {
117 117
      return new HeapCrossRef(g);
118 118
    }
119 119

	
120 120
    ///The heap type used by the Dijkstra algorithm.
121 121

	
122 122
    ///The heap type used by the Dijkstra algorithm.
123 123
    ///
124 124
    ///\sa BinHeap
125 125
    ///\sa Dijkstra
126 126
    typedef BinHeap<typename LM::Value, HeapCrossRef, std::less<Value> > Heap;
127 127
    ///Instantiates a \ref Heap.
128 128

	
129 129
    ///This function instantiates a \ref Heap.
130 130
    static Heap *createHeap(HeapCrossRef& r)
131 131
    {
132 132
      return new Heap(r);
133 133
    }
134 134

	
135 135
    ///\brief The type of the map that stores the predecessor
136 136
    ///arcs of the shortest paths.
137 137
    ///
138 138
    ///The type of the map that stores the predecessor
139 139
    ///arcs of the shortest paths.
140 140
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
141 141
    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
142 142
    ///Instantiates a \ref PredMap.
143 143

	
144 144
    ///This function instantiates a \ref PredMap.
145 145
    ///\param g is the digraph, to which we would like to define the
146 146
    ///\ref PredMap.
147
    ///\todo The digraph alone may be insufficient for the initialization
148 147
    static PredMap *createPredMap(const Digraph &g)
149 148
    {
150 149
      return new PredMap(g);
151 150
    }
152 151

	
153 152
    ///The type of the map that indicates which nodes are processed.
154 153

	
155 154
    ///The type of the map that indicates which nodes are processed.
156 155
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
157 156
    ///By default it is a NullMap.
158
    ///\todo If it is set to a real map,
159
    ///Dijkstra::processed() should read this.
160 157
    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
161 158
    ///Instantiates a \ref ProcessedMap.
162 159

	
163 160
    ///This function instantiates a \ref ProcessedMap.
164 161
    ///\param g is the digraph, to which
165 162
    ///we would like to define the \ref ProcessedMap
166 163
#ifdef DOXYGEN
167 164
    static ProcessedMap *createProcessedMap(const Digraph &g)
168 165
#else
169 166
    static ProcessedMap *createProcessedMap(const Digraph &)
170 167
#endif
171 168
    {
172 169
      return new ProcessedMap();
173 170
    }
174 171

	
175 172
    ///The type of the map that stores the distances of the nodes.
176 173

	
177 174
    ///The type of the map that stores the distances of the nodes.
178 175
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
179 176
    typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
180 177
    ///Instantiates a \ref DistMap.
181 178

	
182 179
    ///This function instantiates a \ref DistMap.
183 180
    ///\param g is the digraph, to which we would like to define
184 181
    ///the \ref DistMap
185 182
    static DistMap *createDistMap(const Digraph &g)
186 183
    {
187 184
      return new DistMap(g);
188 185
    }
189 186
  };
190 187

	
191 188
  ///%Dijkstra algorithm class.
192 189

	
193 190
  /// \ingroup shortest_path
194 191
  ///This class provides an efficient implementation of the %Dijkstra algorithm.
195 192
  ///
196 193
  ///The arc lengths are passed to the algorithm using a
197 194
  ///\ref concepts::ReadMap "ReadMap",
198 195
  ///so it is easy to change it to any kind of length.
199 196
  ///The type of the length is determined by the
200 197
  ///\ref concepts::ReadMap::Value "Value" of the length map.
201 198
  ///It is also possible to change the underlying priority heap.
202 199
  ///
203 200
  ///There is also a \ref dijkstra() "function-type interface" for the
204 201
  ///%Dijkstra algorithm, which is convenient in the simplier cases and
205 202
  ///it can be used easier.
206 203
  ///
207 204
  ///\tparam GR The type of the digraph the algorithm runs on.
208 205
  ///The default value is \ref ListDigraph.
209 206
  ///The value of GR is not used directly by \ref Dijkstra, it is only
210 207
  ///passed to \ref DijkstraDefaultTraits.
211 208
  ///\tparam LM A readable arc map that determines the lengths of the
212 209
  ///arcs. It is read once for each arc, so the map may involve in
213 210
  ///relatively time consuming process to compute the arc lengths if
214 211
  ///it is necessary. The default map type is \ref
215 212
  ///concepts::Digraph::ArcMap "Digraph::ArcMap<int>".
216 213
  ///The value of LM is not used directly by \ref Dijkstra, it is only
217 214
  ///passed to \ref DijkstraDefaultTraits.
218 215
  ///\tparam TR Traits class to set various data types used by the algorithm.
219 216
  ///The default traits class is \ref DijkstraDefaultTraits
220 217
  ///"DijkstraDefaultTraits<GR,LM>". See \ref DijkstraDefaultTraits
221 218
  ///for the documentation of a Dijkstra traits class.
222 219
#ifdef DOXYGEN
223 220
  template <typename GR, typename LM, typename TR>
224 221
#else
225 222
  template <typename GR=ListDigraph,
226 223
            typename LM=typename GR::template ArcMap<int>,
227 224
            typename TR=DijkstraDefaultTraits<GR,LM> >
228 225
#endif
229 226
  class Dijkstra {
230 227
  public:
231 228
    ///\ref Exception for uninitialized parameters.
232 229

	
233 230
    ///This error represents problems in the initialization of the
234 231
    ///parameters of the algorithm.
235 232
    class UninitializedParameter : public lemon::UninitializedParameter {
236 233
    public:
237 234
      virtual const char* what() const throw() {
238 235
        return "lemon::Dijkstra::UninitializedParameter";
239 236
      }
240 237
    };
241 238

	
242 239
    ///The type of the digraph the algorithm runs on.
243 240
    typedef typename TR::Digraph Digraph;
244 241

	
245 242
    ///The type of the length of the arcs.
246 243
    typedef typename TR::LengthMap::Value Value;
247 244
    ///The type of the map that stores the arc lengths.
248 245
    typedef typename TR::LengthMap LengthMap;
249 246
    ///\brief The type of the map that stores the predecessor arcs of the
250 247
    ///shortest paths.
251 248
    typedef typename TR::PredMap PredMap;
252 249
    ///The type of the map that stores the distances of the nodes.
253 250
    typedef typename TR::DistMap DistMap;
254 251
    ///The type of the map that indicates which nodes are processed.
255 252
    typedef typename TR::ProcessedMap ProcessedMap;
256 253
    ///The type of the paths.
257 254
    typedef PredMapPath<Digraph, PredMap> Path;
258 255
    ///The cross reference type used for the current heap.
259 256
    typedef typename TR::HeapCrossRef HeapCrossRef;
260 257
    ///The heap type used by the algorithm.
261 258
    typedef typename TR::Heap Heap;
262 259
    ///The operation traits class.
263 260
    typedef typename TR::OperationTraits OperationTraits;
264 261

	
265 262
    ///The traits class.
266 263
    typedef TR Traits;
267 264

	
268 265
  private:
269 266

	
270 267
    typedef typename Digraph::Node Node;
271 268
    typedef typename Digraph::NodeIt NodeIt;
272 269
    typedef typename Digraph::Arc Arc;
273 270
    typedef typename Digraph::OutArcIt OutArcIt;
274 271

	
275 272
    //Pointer to the underlying digraph.
276 273
    const Digraph *G;
277 274
    //Pointer to the length map.
278 275
    const LengthMap *length;
279 276
    //Pointer to the map of predecessors arcs.
280 277
    PredMap *_pred;
281 278
    //Indicates if _pred is locally allocated (true) or not.
282 279
    bool local_pred;
283 280
    //Pointer to the map of distances.
284 281
    DistMap *_dist;
285 282
    //Indicates if _dist is locally allocated (true) or not.
286 283
    bool local_dist;
287 284
    //Pointer to the map of processed status of the nodes.
288 285
    ProcessedMap *_processed;
289 286
    //Indicates if _processed is locally allocated (true) or not.
290 287
    bool local_processed;
291 288
    //Pointer to the heap cross references.
292 289
    HeapCrossRef *_heap_cross_ref;
293 290
    //Indicates if _heap_cross_ref is locally allocated (true) or not.
294 291
    bool local_heap_cross_ref;
295 292
    //Pointer to the heap.
296 293
    Heap *_heap;
297 294
    //Indicates if _heap is locally allocated (true) or not.
298 295
    bool local_heap;
299 296

	
300
    ///Creates the maps if necessary.
301
    ///\todo Better memory allocation (instead of new).
297
    //Creates the maps if necessary.
302 298
    void create_maps()
303 299
    {
304 300
      if(!_pred) {
305 301
        local_pred = true;
306 302
        _pred = Traits::createPredMap(*G);
307 303
      }
308 304
      if(!_dist) {
309 305
        local_dist = true;
310 306
        _dist = Traits::createDistMap(*G);
311 307
      }
312 308
      if(!_processed) {
313 309
        local_processed = true;
314 310
        _processed = Traits::createProcessedMap(*G);
315 311
      }
316 312
      if (!_heap_cross_ref) {
317 313
        local_heap_cross_ref = true;
318 314
        _heap_cross_ref = Traits::createHeapCrossRef(*G);
319 315
      }
320 316
      if (!_heap) {
321 317
        local_heap = true;
322 318
        _heap = Traits::createHeap(*_heap_cross_ref);
323 319
      }
324 320
    }
325 321

	
326 322
  public:
327 323

	
328 324
    typedef Dijkstra Create;
329 325

	
330 326
    ///\name Named template parameters
331 327

	
332 328
    ///@{
333 329

	
334 330
    template <class T>
335 331
    struct SetPredMapTraits : public Traits {
336 332
      typedef T PredMap;
337 333
      static PredMap *createPredMap(const Digraph &)
338 334
      {
339 335
        throw UninitializedParameter();
340 336
      }
341 337
    };
342 338
    ///\brief \ref named-templ-param "Named parameter" for setting
343 339
    ///\ref PredMap type.
344 340
    ///
345 341
    ///\ref named-templ-param "Named parameter" for setting
346 342
    ///\ref PredMap type.
347 343
    template <class T>
348 344
    struct SetPredMap
349 345
      : public Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > {
350 346
      typedef Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > Create;
351 347
    };
352 348

	
353 349
    template <class T>
354 350
    struct SetDistMapTraits : public Traits {
355 351
      typedef T DistMap;
356 352
      static DistMap *createDistMap(const Digraph &)
357 353
      {
358 354
        throw UninitializedParameter();
359 355
      }
360 356
    };
361 357
    ///\brief \ref named-templ-param "Named parameter" for setting
362 358
    ///\ref DistMap type.
363 359
    ///
364 360
    ///\ref named-templ-param "Named parameter" for setting
365 361
    ///\ref DistMap type.
366 362
    template <class T>
367 363
    struct SetDistMap
368 364
      : public Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > {
369 365
      typedef Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > Create;
370 366
    };
371 367

	
372 368
    template <class T>
373 369
    struct SetProcessedMapTraits : public Traits {
374 370
      typedef T ProcessedMap;
375 371
      static ProcessedMap *createProcessedMap(const Digraph &)
376 372
      {
377 373
        throw UninitializedParameter();
378 374
      }
379 375
    };
380 376
    ///\brief \ref named-templ-param "Named parameter" for setting
381 377
    ///\ref ProcessedMap type.
382 378
    ///
383 379
    ///\ref named-templ-param "Named parameter" for setting
384 380
    ///\ref ProcessedMap type.
385 381
    template <class T>
386 382
    struct SetProcessedMap
387 383
      : public Dijkstra< Digraph, LengthMap, SetProcessedMapTraits<T> > {
388 384
      typedef Dijkstra< Digraph, LengthMap, SetProcessedMapTraits<T> > Create;
389 385
    };
390 386

	
391 387
    struct SetStandardProcessedMapTraits : public Traits {
392 388
      typedef typename Digraph::template NodeMap<bool> ProcessedMap;
393 389
      static ProcessedMap *createProcessedMap(const Digraph &g)
394 390
      {
395 391
        return new ProcessedMap(g);
396 392
      }
397 393
    };
398 394
    ///\brief \ref named-templ-param "Named parameter" for setting
399 395
    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
400 396
    ///
401 397
    ///\ref named-templ-param "Named parameter" for setting
402 398
    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
403 399
    ///If you don't set it explicitly, it will be automatically allocated.
404 400
    struct SetStandardProcessedMap
405 401
      : public Dijkstra< Digraph, LengthMap, SetStandardProcessedMapTraits > {
406 402
      typedef Dijkstra< Digraph, LengthMap, SetStandardProcessedMapTraits >
407 403
      Create;
408 404
    };
409 405

	
410 406
    template <class H, class CR>
411 407
    struct SetHeapTraits : public Traits {
412 408
      typedef CR HeapCrossRef;
413 409
      typedef H Heap;
414 410
      static HeapCrossRef *createHeapCrossRef(const Digraph &) {
415 411
        throw UninitializedParameter();
416 412
      }
417 413
      static Heap *createHeap(HeapCrossRef &)
418 414
      {
419 415
        throw UninitializedParameter();
420 416
      }
421 417
    };
422 418
    ///\brief \ref named-templ-param "Named parameter" for setting
423 419
    ///heap and cross reference type
424 420
    ///
425 421
    ///\ref named-templ-param "Named parameter" for setting heap and cross
426 422
    ///reference type.
427 423
    template <class H, class CR = typename Digraph::template NodeMap<int> >
428 424
    struct SetHeap
429 425
      : public Dijkstra< Digraph, LengthMap, SetHeapTraits<H, CR> > {
430 426
      typedef Dijkstra< Digraph, LengthMap, SetHeapTraits<H, CR> > Create;
431 427
    };
432 428

	
433 429
    template <class H, class CR>
434 430
    struct SetStandardHeapTraits : public Traits {
435 431
      typedef CR HeapCrossRef;
436 432
      typedef H Heap;
437 433
      static HeapCrossRef *createHeapCrossRef(const Digraph &G) {
438 434
        return new HeapCrossRef(G);
439 435
      }
440 436
      static Heap *createHeap(HeapCrossRef &R)
441 437
      {
442 438
        return new Heap(R);
443 439
      }
444 440
    };
445 441
    ///\brief \ref named-templ-param "Named parameter" for setting
446 442
    ///heap and cross reference type with automatic allocation
447 443
    ///
448 444
    ///\ref named-templ-param "Named parameter" for setting heap and cross
449 445
    ///reference type. It can allocate the heap and the cross reference
450 446
    ///object if the cross reference's constructor waits for the digraph as
451 447
    ///parameter and the heap's constructor waits for the cross reference.
452 448
    template <class H, class CR = typename Digraph::template NodeMap<int> >
453 449
    struct SetStandardHeap
454 450
      : public Dijkstra< Digraph, LengthMap, SetStandardHeapTraits<H, CR> > {
455 451
      typedef Dijkstra< Digraph, LengthMap, SetStandardHeapTraits<H, CR> >
456 452
      Create;
457 453
    };
458 454

	
459 455
    template <class T>
460 456
    struct SetOperationTraitsTraits : public Traits {
461 457
      typedef T OperationTraits;
462 458
    };
463 459

	
464 460
    /// \brief \ref named-templ-param "Named parameter" for setting
465 461
    ///\ref OperationTraits type
466 462
    ///
467 463
    ///\ref named-templ-param "Named parameter" for setting
468 464
    ///\ref OperationTraits type.
469 465
    template <class T>
470 466
    struct SetOperationTraits
471 467
      : public Dijkstra<Digraph, LengthMap, SetOperationTraitsTraits<T> > {
472 468
      typedef Dijkstra<Digraph, LengthMap, SetOperationTraitsTraits<T> >
473 469
      Create;
474 470
    };
475 471

	
476 472
    ///@}
477 473

	
478 474
  protected:
479 475

	
480 476
    Dijkstra() {}
481 477

	
482 478
  public:
483 479

	
484 480
    ///Constructor.
485 481

	
486 482
    ///Constructor.
487 483
    ///\param _g The digraph the algorithm runs on.
488 484
    ///\param _length The length map used by the algorithm.
489 485
    Dijkstra(const Digraph& _g, const LengthMap& _length) :
490 486
      G(&_g), length(&_length),
491 487
      _pred(NULL), local_pred(false),
492 488
      _dist(NULL), local_dist(false),
493 489
      _processed(NULL), local_processed(false),
494 490
      _heap_cross_ref(NULL), local_heap_cross_ref(false),
495 491
      _heap(NULL), local_heap(false)
496 492
    { }
497 493

	
498 494
    ///Destructor.
499 495
    ~Dijkstra()
500 496
    {
501 497
      if(local_pred) delete _pred;
502 498
      if(local_dist) delete _dist;
503 499
      if(local_processed) delete _processed;
504 500
      if(local_heap_cross_ref) delete _heap_cross_ref;
505 501
      if(local_heap) delete _heap;
506 502
    }
507 503

	
508 504
    ///Sets the length map.
509 505

	
510 506
    ///Sets the length map.
511 507
    ///\return <tt> (*this) </tt>
512 508
    Dijkstra &lengthMap(const LengthMap &m)
513 509
    {
514 510
      length = &m;
515 511
      return *this;
516 512
    }
517 513

	
518 514
    ///Sets the map that stores the predecessor arcs.
519 515

	
520 516
    ///Sets the map that stores the predecessor arcs.
521 517
    ///If you don't use this function before calling \ref run(),
522 518
    ///it will allocate one. The destructor deallocates this
523 519
    ///automatically allocated map, of course.
524 520
    ///\return <tt> (*this) </tt>
525 521
    Dijkstra &predMap(PredMap &m)
526 522
    {
527 523
      if(local_pred) {
528 524
        delete _pred;
529 525
        local_pred=false;
530 526
      }
531 527
      _pred = &m;
532 528
      return *this;
533 529
    }
534 530

	
535 531
    ///Sets the map that indicates which nodes are processed.
536 532

	
537 533
    ///Sets the map that indicates which nodes are processed.
538 534
    ///If you don't use this function before calling \ref run(),
539 535
    ///it will allocate one. The destructor deallocates this
540 536
    ///automatically allocated map, of course.
541 537
    ///\return <tt> (*this) </tt>
542 538
    Dijkstra &processedMap(ProcessedMap &m)
543 539
    {
544 540
      if(local_processed) {
545 541
        delete _processed;
546 542
        local_processed=false;
547 543
      }
548 544
      _processed = &m;
549 545
      return *this;
550 546
    }
551 547

	
552 548
    ///Sets the map that stores the distances of the nodes.
553 549

	
554 550
    ///Sets the map that stores the distances of the nodes calculated by the
555 551
    ///algorithm.
556 552
    ///If you don't use this function before calling \ref run(),
557 553
    ///it will allocate one. The destructor deallocates this
558 554
    ///automatically allocated map, of course.
559 555
    ///\return <tt> (*this) </tt>
560 556
    Dijkstra &distMap(DistMap &m)
561 557
    {
562 558
      if(local_dist) {
563 559
        delete _dist;
564 560
        local_dist=false;
565 561
      }
566 562
      _dist = &m;
567 563
      return *this;
568 564
    }
569 565

	
570 566
    ///Sets the heap and the cross reference used by algorithm.
571 567

	
572 568
    ///Sets the heap and the cross reference used by algorithm.
573 569
    ///If you don't use this function before calling \ref run(),
574 570
    ///it will allocate one. The destructor deallocates this
575 571
    ///automatically allocated heap and cross reference, of course.
576 572
    ///\return <tt> (*this) </tt>
577 573
    Dijkstra &heap(Heap& hp, HeapCrossRef &cr)
578 574
    {
579 575
      if(local_heap_cross_ref) {
580 576
        delete _heap_cross_ref;
581 577
        local_heap_cross_ref=false;
582 578
      }
583 579
      _heap_cross_ref = &cr;
584 580
      if(local_heap) {
585 581
        delete _heap;
586 582
        local_heap=false;
587 583
      }
588 584
      _heap = &hp;
589 585
      return *this;
590 586
    }
591 587

	
592 588
  private:
593 589

	
594 590
    void finalizeNodeData(Node v,Value dst)
595 591
    {
596 592
      _processed->set(v,true);
597 593
      _dist->set(v, dst);
598 594
    }
599 595

	
600 596
  public:
601 597

	
602 598
    ///\name Execution control
603 599
    ///The simplest way to execute the algorithm is to use one of the
604 600
    ///member functions called \ref lemon::Dijkstra::run() "run()".
605 601
    ///\n
606 602
    ///If you need more control on the execution, first you must call
607 603
    ///\ref lemon::Dijkstra::init() "init()", then you can add several
608 604
    ///source nodes with \ref lemon::Dijkstra::addSource() "addSource()".
609 605
    ///Finally \ref lemon::Dijkstra::start() "start()" will perform the
610 606
    ///actual path computation.
611 607

	
612 608
    ///@{
613 609

	
614 610
    ///Initializes the internal data structures.
615 611

	
616 612
    ///Initializes the internal data structures.
617 613
    ///
618 614
    void init()
619 615
    {
620 616
      create_maps();
621 617
      _heap->clear();
622 618
      for ( NodeIt u(*G) ; u!=INVALID ; ++u ) {
623 619
        _pred->set(u,INVALID);
624 620
        _processed->set(u,false);
625 621
        _heap_cross_ref->set(u,Heap::PRE_HEAP);
626 622
      }
627 623
    }
628 624

	
629 625
    ///Adds a new source node.
630 626

	
631 627
    ///Adds a new source node to the priority heap.
632 628
    ///The optional second parameter is the initial distance of the node.
633 629
    ///
634 630
    ///The function checks if the node has already been added to the heap and
635 631
    ///it is pushed to the heap only if either it was not in the heap
636 632
    ///or the shortest path found till then is shorter than \c dst.
637 633
    void addSource(Node s,Value dst=OperationTraits::zero())
638 634
    {
639 635
      if(_heap->state(s) != Heap::IN_HEAP) {
640 636
        _heap->push(s,dst);
641 637
      } else if(OperationTraits::less((*_heap)[s], dst)) {
642 638
        _heap->set(s,dst);
643 639
        _pred->set(s,INVALID);
644 640
      }
645 641
    }
646 642

	
647 643
    ///Processes the next node in the priority heap
648 644

	
649 645
    ///Processes the next node in the priority heap.
650 646
    ///
651 647
    ///\return The processed node.
652 648
    ///
653 649
    ///\warning The priority heap must not be empty.
654 650
    Node processNextNode()
655 651
    {
656 652
      Node v=_heap->top();
657 653
      Value oldvalue=_heap->prio();
658 654
      _heap->pop();
659 655
      finalizeNodeData(v,oldvalue);
660 656

	
661 657
      for(OutArcIt e(*G,v); e!=INVALID; ++e) {
662 658
        Node w=G->target(e);
663 659
        switch(_heap->state(w)) {
664 660
        case Heap::PRE_HEAP:
665 661
          _heap->push(w,OperationTraits::plus(oldvalue, (*length)[e]));
666 662
          _pred->set(w,e);
667 663
          break;
668 664
        case Heap::IN_HEAP:
669 665
          {
670 666
            Value newvalue = OperationTraits::plus(oldvalue, (*length)[e]);
671 667
            if ( OperationTraits::less(newvalue, (*_heap)[w]) ) {
672 668
              _heap->decrease(w, newvalue);
673 669
              _pred->set(w,e);
674 670
            }
675 671
          }
676 672
          break;
677 673
        case Heap::POST_HEAP:
678 674
          break;
679 675
        }
680 676
      }
681 677
      return v;
682 678
    }
683 679

	
684 680
    ///The next node to be processed.
685 681

	
686 682
    ///Returns the next node to be processed or \c INVALID if the
687 683
    ///priority heap is empty.
688 684
    Node nextNode() const
689 685
    {
690 686
      return !_heap->empty()?_heap->top():INVALID;
691 687
    }
692 688

	
693 689
    ///\brief Returns \c false if there are nodes
694 690
    ///to be processed.
695 691
    ///
696 692
    ///Returns \c false if there are nodes
697 693
    ///to be processed in the priority heap.
698 694
    bool emptyQueue() const { return _heap->empty(); }
699 695

	
700 696
    ///Returns the number of the nodes to be processed in the priority heap
701 697

	
702 698
    ///Returns the number of the nodes to be processed in the priority heap.
703 699
    ///
704 700
    int queueSize() const { return _heap->size(); }
705 701

	
706 702
    ///Executes the algorithm.
707 703

	
708 704
    ///Executes the algorithm.
709 705
    ///
710 706
    ///This method runs the %Dijkstra algorithm from the root node(s)
711 707
    ///in order to compute the shortest path to each node.
712 708
    ///
713 709
    ///The algorithm computes
714 710
    ///- the shortest path tree (forest),
715 711
    ///- the distance of each node from the root(s).
716 712
    ///
717 713
    ///\pre init() must be called and at least one root node should be
718 714
    ///added with addSource() before using this function.
719 715
    ///
720 716
    ///\note <tt>d.start()</tt> is just a shortcut of the following code.
721 717
    ///\code
722 718
    ///  while ( !d.emptyQueue() ) {
723 719
    ///    d.processNextNode();
724 720
    ///  }
725 721
    ///\endcode
726 722
    void start()
727 723
    {
728 724
      while ( !emptyQueue() ) processNextNode();
729 725
    }
730 726

	
731 727
    ///Executes the algorithm until the given target node is reached.
732 728

	
733 729
    ///Executes the algorithm until the given target node is reached.
734 730
    ///
735 731
    ///This method runs the %Dijkstra algorithm from the root node(s)
736 732
    ///in order to compute the shortest path to \c dest.
737 733
    ///
738 734
    ///The algorithm computes
739 735
    ///- the shortest path to \c dest,
740 736
    ///- the distance of \c dest from the root(s).
741 737
    ///
742 738
    ///\pre init() must be called and at least one root node should be
743 739
    ///added with addSource() before using this function.
744 740
    void start(Node dest)
745 741
    {
746 742
      while ( !_heap->empty() && _heap->top()!=dest ) processNextNode();
747 743
      if ( !_heap->empty() ) finalizeNodeData(_heap->top(),_heap->prio());
748 744
    }
749 745

	
750 746
    ///Executes the algorithm until a condition is met.
751 747

	
752 748
    ///Executes the algorithm until a condition is met.
753 749
    ///
754 750
    ///This method runs the %Dijkstra algorithm from the root node(s) in
755 751
    ///order to compute the shortest path to a node \c v with
756 752
    /// <tt>nm[v]</tt> true, if such a node can be found.
757 753
    ///
758 754
    ///\param nm A \c bool (or convertible) node map. The algorithm
759 755
    ///will stop when it reaches a node \c v with <tt>nm[v]</tt> true.
760 756
    ///
761 757
    ///\return The reached node \c v with <tt>nm[v]</tt> true or
762 758
    ///\c INVALID if no such node was found.
763 759
    ///
764 760
    ///\pre init() must be called and at least one root node should be
765 761
    ///added with addSource() before using this function.
766 762
    template<class NodeBoolMap>
767 763
    Node start(const NodeBoolMap &nm)
768 764
    {
769 765
      while ( !_heap->empty() && !nm[_heap->top()] ) processNextNode();
770 766
      if ( _heap->empty() ) return INVALID;
771 767
      finalizeNodeData(_heap->top(),_heap->prio());
772 768
      return _heap->top();
773 769
    }
774 770

	
775 771
    ///Runs the algorithm from the given node.
776 772

	
777 773
    ///This method runs the %Dijkstra algorithm from node \c s
778 774
    ///in order to compute the shortest path to each node.
779 775
    ///
780 776
    ///The algorithm computes
781 777
    ///- the shortest path tree,
782 778
    ///- the distance of each node from the root.
783 779
    ///
784 780
    ///\note <tt>d.run(s)</tt> is just a shortcut of the following code.
785 781
    ///\code
786 782
    ///  d.init();
787 783
    ///  d.addSource(s);
788 784
    ///  d.start();
789 785
    ///\endcode
790 786
    void run(Node s) {
791 787
      init();
792 788
      addSource(s);
793 789
      start();
794 790
    }
795 791

	
796 792
    ///Finds the shortest path between \c s and \c t.
797 793

	
798 794
    ///This method runs the %Dijkstra algorithm from node \c s
799 795
    ///in order to compute the shortest path to \c t.
800 796
    ///
801 797
    ///\return The length of the shortest <tt>s</tt>--<tt>t</tt> path,
802 798
    ///if \c t is reachable form \c s, \c 0 otherwise.
803 799
    ///
804 800
    ///\note Apart from the return value, <tt>d.run(s,t)</tt> is just a
805 801
    ///shortcut of the following code.
806 802
    ///\code
807 803
    ///  d.init();
808 804
    ///  d.addSource(s);
809 805
    ///  d.start(t);
810 806
    ///\endcode
811 807
    Value run(Node s,Node t) {
812 808
      init();
813 809
      addSource(s);
814 810
      start(t);
815 811
      return (*_pred)[t]==INVALID?OperationTraits::zero():(*_dist)[t];
816 812
    }
817 813

	
818 814
    ///@}
819 815

	
820 816
    ///\name Query Functions
821 817
    ///The result of the %Dijkstra algorithm can be obtained using these
822 818
    ///functions.\n
823 819
    ///Either \ref lemon::Dijkstra::run() "run()" or
824 820
    ///\ref lemon::Dijkstra::start() "start()" must be called before
825 821
    ///using them.
826 822

	
827 823
    ///@{
828 824

	
829 825
    ///The shortest path to a node.
830 826

	
831 827
    ///Returns the shortest path to a node.
832 828
    ///
833 829
    ///\warning \c t should be reachable from the root(s).
834 830
    ///
835 831
    ///\pre Either \ref run() or \ref start() must be called before
836 832
    ///using this function.
837 833
    Path path(Node t) const { return Path(*G, *_pred, t); }
838 834

	
839 835
    ///The distance of a node from the root(s).
840 836

	
841 837
    ///Returns the distance of a node from the root(s).
842 838
    ///
843 839
    ///\warning If node \c v is not reachable from the root(s), then
844 840
    ///the return value of this function is undefined.
845 841
    ///
846 842
    ///\pre Either \ref run() or \ref start() must be called before
847 843
    ///using this function.
848 844
    Value dist(Node v) const { return (*_dist)[v]; }
849 845

	
850 846
    ///Returns the 'previous arc' of the shortest path tree for a node.
851 847

	
852 848
    ///This function returns the 'previous arc' of the shortest path
853 849
    ///tree for the node \c v, i.e. it returns the last arc of a
854 850
    ///shortest path from the root(s) to \c v. It is \c INVALID if \c v
855 851
    ///is not reachable from the root(s) or if \c v is a root.
856 852
    ///
857 853
    ///The shortest path tree used here is equal to the shortest path
858 854
    ///tree used in \ref predNode().
859 855
    ///
860 856
    ///\pre Either \ref run() or \ref start() must be called before
861 857
    ///using this function.
862 858
    Arc predArc(Node v) const { return (*_pred)[v]; }
863 859

	
864 860
    ///Returns the 'previous node' of the shortest path tree for a node.
865 861

	
866 862
    ///This function returns the 'previous node' of the shortest path
867 863
    ///tree for the node \c v, i.e. it returns the last but one node
868 864
    ///from a shortest path from the root(s) to \c v. It is \c INVALID
869 865
    ///if \c v is not reachable from the root(s) or if \c v is a root.
870 866
    ///
871 867
    ///The shortest path tree used here is equal to the shortest path
872 868
    ///tree used in \ref predArc().
873 869
    ///
874 870
    ///\pre Either \ref run() or \ref start() must be called before
875 871
    ///using this function.
876 872
    Node predNode(Node v) const { return (*_pred)[v]==INVALID ? INVALID:
877 873
                                  G->source((*_pred)[v]); }
878 874

	
879 875
    ///\brief Returns a const reference to the node map that stores the
880 876
    ///distances of the nodes.
881 877
    ///
882 878
    ///Returns a const reference to the node map that stores the distances
883 879
    ///of the nodes calculated by the algorithm.
884 880
    ///
885 881
    ///\pre Either \ref run() or \ref init()
886 882
    ///must be called before using this function.
887 883
    const DistMap &distMap() const { return *_dist;}
888 884

	
889 885
    ///\brief Returns a const reference to the node map that stores the
890 886
    ///predecessor arcs.
891 887
    ///
892 888
    ///Returns a const reference to the node map that stores the predecessor
893 889
    ///arcs, which form the shortest path tree.
894 890
    ///
895 891
    ///\pre Either \ref run() or \ref init()
896 892
    ///must be called before using this function.
897 893
    const PredMap &predMap() const { return *_pred;}
898 894

	
899 895
    ///Checks if a node is reachable from the root(s).
900 896

	
901 897
    ///Returns \c true if \c v is reachable from the root(s).
902 898
    ///\pre Either \ref run() or \ref start()
903 899
    ///must be called before using this function.
904 900
    bool reached(Node v) const { return (*_heap_cross_ref)[v] !=
905 901
                                        Heap::PRE_HEAP; }
906 902

	
907 903
    ///Checks if a node is processed.
908 904

	
909 905
    ///Returns \c true if \c v is processed, i.e. the shortest
910 906
    ///path to \c v has already found.
911 907
    ///\pre Either \ref run() or \ref start()
912 908
    ///must be called before using this function.
913 909
    bool processed(Node v) const { return (*_heap_cross_ref)[v] ==
914 910
                                          Heap::POST_HEAP; }
915 911

	
916 912
    ///The current distance of a node from the root(s).
917 913

	
918 914
    ///Returns the current distance of a node from the root(s).
919 915
    ///It may be decreased in the following processes.
920 916
    ///\pre \c v should be reached but not processed.
921 917
    Value currentDist(Node v) const { return (*_heap)[v]; }
922 918

	
923 919
    ///@}
924 920
  };
925 921

	
926 922

	
927 923
  ///Default traits class of dijkstra() function.
928 924

	
929 925
  ///Default traits class of dijkstra() function.
930 926
  ///\tparam GR The type of the digraph.
931 927
  ///\tparam LM The type of the length map.
932 928
  template<class GR, class LM>
933 929
  struct DijkstraWizardDefaultTraits
934 930
  {
935 931
    ///The type of the digraph the algorithm runs on.
936 932
    typedef GR Digraph;
937 933
    ///The type of the map that stores the arc lengths.
938 934

	
939 935
    ///The type of the map that stores the arc lengths.
940 936
    ///It must meet the \ref concepts::ReadMap "ReadMap" concept.
941 937
    typedef LM LengthMap;
942 938
    ///The type of the length of the arcs.
943 939
    typedef typename LM::Value Value;
944 940

	
945 941
    /// Operation traits for Dijkstra algorithm.
946 942

	
947 943
    /// This class defines the operations that are used in the algorithm.
948 944
    /// \see DijkstraDefaultOperationTraits
949 945
    typedef DijkstraDefaultOperationTraits<Value> OperationTraits;
950 946

	
951 947
    /// The cross reference type used by the heap.
952 948

	
953 949
    /// The cross reference type used by the heap.
954 950
    /// Usually it is \c Digraph::NodeMap<int>.
955 951
    typedef typename Digraph::template NodeMap<int> HeapCrossRef;
956 952
    ///Instantiates a \ref HeapCrossRef.
957 953

	
958 954
    ///This function instantiates a \ref HeapCrossRef.
959 955
    /// \param g is the digraph, to which we would like to define the
960 956
    /// HeapCrossRef.
961
    /// \todo The digraph alone may be insufficient for the initialization
962 957
    static HeapCrossRef *createHeapCrossRef(const Digraph &g)
963 958
    {
964 959
      return new HeapCrossRef(g);
965 960
    }
966 961

	
967 962
    ///The heap type used by the Dijkstra algorithm.
968 963

	
969 964
    ///The heap type used by the Dijkstra algorithm.
970 965
    ///
971 966
    ///\sa BinHeap
972 967
    ///\sa Dijkstra
973 968
    typedef BinHeap<Value, typename Digraph::template NodeMap<int>,
974 969
                    std::less<Value> > Heap;
975 970

	
976 971
    ///Instantiates a \ref Heap.
977 972

	
978 973
    ///This function instantiates a \ref Heap.
979 974
    /// \param r is the HeapCrossRef which is used.
980 975
    static Heap *createHeap(HeapCrossRef& r)
981 976
    {
982 977
      return new Heap(r);
983 978
    }
984 979

	
985 980
    ///\brief The type of the map that stores the predecessor
986 981
    ///arcs of the shortest paths.
987 982
    ///
988 983
    ///The type of the map that stores the predecessor
989 984
    ///arcs of the shortest paths.
990 985
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
991 986
    typedef typename Digraph::template NodeMap<typename Digraph::Arc> PredMap;
992 987
    ///Instantiates a \ref PredMap.
993 988

	
994 989
    ///This function instantiates a \ref PredMap.
995 990
    ///\param g is the digraph, to which we would like to define the
996 991
    ///\ref PredMap.
997
    ///\todo The digraph alone may be insufficient to initialize
998 992
    static PredMap *createPredMap(const Digraph &g)
999 993
    {
1000 994
      return new PredMap(g);
1001 995
    }
1002 996

	
1003 997
    ///The type of the map that indicates which nodes are processed.
1004 998

	
1005 999
    ///The type of the map that indicates which nodes are processed.
1006 1000
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
1007 1001
    ///By default it is a NullMap.
1008
    ///\todo If it is set to a real map,
1009
    ///Dijkstra::processed() should read this.
1010
    ///\todo named parameter to set this type, function to read and write.
1011 1002
    typedef NullMap<typename Digraph::Node,bool> ProcessedMap;
1012 1003
    ///Instantiates a \ref ProcessedMap.
1013 1004

	
1014 1005
    ///This function instantiates a \ref ProcessedMap.
1015 1006
    ///\param g is the digraph, to which
1016 1007
    ///we would like to define the \ref ProcessedMap.
1017 1008
#ifdef DOXYGEN
1018 1009
    static ProcessedMap *createProcessedMap(const Digraph &g)
1019 1010
#else
1020 1011
    static ProcessedMap *createProcessedMap(const Digraph &)
1021 1012
#endif
1022 1013
    {
1023 1014
      return new ProcessedMap();
1024 1015
    }
1025 1016

	
1026 1017
    ///The type of the map that stores the distances of the nodes.
1027 1018

	
1028 1019
    ///The type of the map that stores the distances of the nodes.
1029 1020
    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
1030 1021
    typedef typename Digraph::template NodeMap<typename LM::Value> DistMap;
1031 1022
    ///Instantiates a \ref DistMap.
1032 1023

	
1033 1024
    ///This function instantiates a \ref DistMap.
1034 1025
    ///\param g is the digraph, to which we would like to define
1035 1026
    ///the \ref DistMap
1036 1027
    static DistMap *createDistMap(const Digraph &g)
1037 1028
    {
1038 1029
      return new DistMap(g);
1039 1030
    }
1040 1031

	
1041 1032
    ///The type of the shortest paths.
1042 1033

	
1043 1034
    ///The type of the shortest paths.
1044 1035
    ///It must meet the \ref concepts::Path "Path" concept.
1045 1036
    typedef lemon::Path<Digraph> Path;
1046 1037
  };
1047 1038

	
1048 1039
  /// Default traits class used by \ref DijkstraWizard
1049 1040

	
1050 1041
  /// To make it easier to use Dijkstra algorithm
1051 1042
  /// we have created a wizard class.
1052 1043
  /// This \ref DijkstraWizard class needs default traits,
1053 1044
  /// as well as the \ref Dijkstra class.
1054 1045
  /// The \ref DijkstraWizardBase is a class to be the default traits of the
1055 1046
  /// \ref DijkstraWizard class.
1056
  /// \todo More named parameters are required...
1057 1047
  template<class GR,class LM>
1058 1048
  class DijkstraWizardBase : public DijkstraWizardDefaultTraits<GR,LM>
1059 1049
  {
1060 1050
    typedef DijkstraWizardDefaultTraits<GR,LM> Base;
1061 1051
  protected:
1062 1052
    //The type of the nodes in the digraph.
1063 1053
    typedef typename Base::Digraph::Node Node;
1064 1054

	
1065 1055
    //Pointer to the digraph the algorithm runs on.
1066 1056
    void *_g;
1067 1057
    //Pointer to the length map.
1068 1058
    void *_length;
1069 1059
    //Pointer to the map of processed nodes.
1070 1060
    void *_processed;
1071 1061
    //Pointer to the map of predecessors arcs.
1072 1062
    void *_pred;
1073 1063
    //Pointer to the map of distances.
1074 1064
    void *_dist;
1075 1065
    //Pointer to the shortest path to the target node.
1076 1066
    void *_path;
1077 1067
    //Pointer to the distance of the target node.
1078 1068
    void *_di;
1079 1069

	
1080 1070
  public:
1081 1071
    /// Constructor.
1082 1072

	
1083 1073
    /// This constructor does not require parameters, therefore it initiates
1084 1074
    /// all of the attributes to \c 0.
1085 1075
    DijkstraWizardBase() : _g(0), _length(0), _processed(0), _pred(0),
1086 1076
                           _dist(0), _path(0), _di(0) {}
1087 1077

	
1088 1078
    /// Constructor.
1089 1079

	
1090 1080
    /// This constructor requires two parameters,
1091 1081
    /// others are initiated to \c 0.
1092 1082
    /// \param g The digraph the algorithm runs on.
1093 1083
    /// \param l The length map.
1094 1084
    DijkstraWizardBase(const GR &g,const LM &l) :
1095 1085
      _g(reinterpret_cast<void*>(const_cast<GR*>(&g))),
1096 1086
      _length(reinterpret_cast<void*>(const_cast<LM*>(&l))),
1097 1087
      _processed(0), _pred(0), _dist(0), _path(0), _di(0) {}
1098 1088

	
1099 1089
  };
1100 1090

	
1101 1091
  /// Auxiliary class for the function-type interface of Dijkstra algorithm.
1102 1092

	
1103 1093
  /// This auxiliary class is created to implement the
1104 1094
  /// \ref dijkstra() "function-type interface" of \ref Dijkstra algorithm.
1105 1095
  /// It does not have own \ref run() method, it uses the functions
1106 1096
  /// and features of the plain \ref Dijkstra.
1107 1097
  ///
1108 1098
  /// This class should only be used through the \ref dijkstra() function,
1109 1099
  /// which makes it easier to use the algorithm.
1110 1100
  template<class TR>
1111 1101
  class DijkstraWizard : public TR
1112 1102
  {
1113 1103
    typedef TR Base;
1114 1104

	
1115 1105
    ///The type of the digraph the algorithm runs on.
1116 1106
    typedef typename TR::Digraph Digraph;
1117 1107

	
1118 1108
    typedef typename Digraph::Node Node;
1119 1109
    typedef typename Digraph::NodeIt NodeIt;
1120 1110
    typedef typename Digraph::Arc Arc;
1121 1111
    typedef typename Digraph::OutArcIt OutArcIt;
1122 1112

	
1123 1113
    ///The type of the map that stores the arc lengths.
1124 1114
    typedef typename TR::LengthMap LengthMap;
1125 1115
    ///The type of the length of the arcs.
1126 1116
    typedef typename LengthMap::Value Value;
1127 1117
    ///\brief The type of the map that stores the predecessor
1128 1118
    ///arcs of the shortest paths.
1129 1119
    typedef typename TR::PredMap PredMap;
1130 1120
    ///The type of the map that stores the distances of the nodes.
1131 1121
    typedef typename TR::DistMap DistMap;
1132 1122
    ///The type of the map that indicates which nodes are processed.
1133 1123
    typedef typename TR::ProcessedMap ProcessedMap;
1134 1124
    ///The type of the shortest paths
1135 1125
    typedef typename TR::Path Path;
1136 1126
    ///The heap type used by the dijkstra algorithm.
1137 1127
    typedef typename TR::Heap Heap;
1138 1128

	
1139 1129
  public:
1140 1130

	
1141 1131
    /// Constructor.
1142 1132
    DijkstraWizard() : TR() {}
1143 1133

	
1144 1134
    /// Constructor that requires parameters.
1145 1135

	
1146 1136
    /// Constructor that requires parameters.
1147 1137
    /// These parameters will be the default values for the traits class.
1148 1138
    /// \param g The digraph the algorithm runs on.
1149 1139
    /// \param l The length map.
1150 1140
    DijkstraWizard(const Digraph &g, const LengthMap &l) :
1151 1141
      TR(g,l) {}
1152 1142

	
1153 1143
    ///Copy constructor
1154 1144
    DijkstraWizard(const TR &b) : TR(b) {}
1155 1145

	
1156 1146
    ~DijkstraWizard() {}
1157 1147

	
1158 1148
    ///Runs Dijkstra algorithm from the given source node.
1159 1149

	
1160 1150
    ///This method runs %Dijkstra algorithm from the given source node
1161 1151
    ///in order to compute the shortest path to each node.
1162 1152
    void run(Node s)
1163 1153
    {
1164 1154
      if (s==INVALID) throw UninitializedParameter();
1165 1155
      Dijkstra<Digraph,LengthMap,TR>
1166 1156
        dijk(*reinterpret_cast<const Digraph*>(Base::_g),
1167 1157
             *reinterpret_cast<const LengthMap*>(Base::_length));
1168 1158
      if (Base::_pred)
1169 1159
        dijk.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
1170 1160
      if (Base::_dist)
1171 1161
        dijk.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
1172 1162
      if (Base::_processed)
1173 1163
        dijk.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));
1174 1164
      dijk.run(s);
1175 1165
    }
1176 1166

	
1177 1167
    ///Finds the shortest path between \c s and \c t.
1178 1168

	
1179 1169
    ///This method runs the %Dijkstra algorithm from node \c s
1180 1170
    ///in order to compute the shortest path to node \c t
1181 1171
    ///(it stops searching when \c t is processed).
1182 1172
    ///
1183 1173
    ///\return \c true if \c t is reachable form \c s.
1184 1174
    bool run(Node s, Node t)
1185 1175
    {
1186 1176
      if (s==INVALID || t==INVALID) throw UninitializedParameter();
1187 1177
      Dijkstra<Digraph,LengthMap,TR>
1188 1178
        dijk(*reinterpret_cast<const Digraph*>(Base::_g),
1189 1179
             *reinterpret_cast<const LengthMap*>(Base::_length));
1190 1180
      if (Base::_pred)
1191 1181
        dijk.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
1192 1182
      if (Base::_dist)
1193 1183
        dijk.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
1194 1184
      if (Base::_processed)
1195 1185
        dijk.processedMap(*reinterpret_cast<ProcessedMap*>(Base::_processed));
1196 1186
      dijk.run(s,t);
1197 1187
      if (Base::_path)
1198 1188
        *reinterpret_cast<Path*>(Base::_path) = dijk.path(t);
1199 1189
      if (Base::_di)
1200 1190
        *reinterpret_cast<Value*>(Base::_di) = dijk.dist(t);
1201 1191
      return dijk.reached(t);
1202 1192
    }
1203 1193

	
1204 1194
    template<class T>
1205 1195
    struct SetPredMapBase : public Base {
1206 1196
      typedef T PredMap;
1207 1197
      static PredMap *createPredMap(const Digraph &) { return 0; };
1208 1198
      SetPredMapBase(const TR &b) : TR(b) {}
1209 1199
    };
1210 1200
    ///\brief \ref named-func-param "Named parameter"
1211 1201
    ///for setting \ref PredMap object.
1212 1202
    ///
1213 1203
    ///\ref named-func-param "Named parameter"
1214 1204
    ///for setting \ref PredMap object.
1215 1205
    template<class T>
1216 1206
    DijkstraWizard<SetPredMapBase<T> > predMap(const T &t)
1217 1207
    {
1218 1208
      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));
1219 1209
      return DijkstraWizard<SetPredMapBase<T> >(*this);
1220 1210
    }
1221 1211

	
1222 1212
    template<class T>
1223 1213
    struct SetDistMapBase : public Base {
1224 1214
      typedef T DistMap;
1225 1215
      static DistMap *createDistMap(const Digraph &) { return 0; };
1226 1216
      SetDistMapBase(const TR &b) : TR(b) {}
1227 1217
    };
1228 1218
    ///\brief \ref named-func-param "Named parameter"
1229 1219
    ///for setting \ref DistMap object.
1230 1220
    ///
1231 1221
    ///\ref named-func-param "Named parameter"
1232 1222
    ///for setting \ref DistMap object.
1233 1223
    template<class T>
1234 1224
    DijkstraWizard<SetDistMapBase<T> > distMap(const T &t)
1235 1225
    {
1236 1226
      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));
1237 1227
      return DijkstraWizard<SetDistMapBase<T> >(*this);
1238 1228
    }
1239 1229

	
1240 1230
    template<class T>
1241 1231
    struct SetProcessedMapBase : public Base {
1242 1232
      typedef T ProcessedMap;
1243 1233
      static ProcessedMap *createProcessedMap(const Digraph &) { return 0; };
1244 1234
      SetProcessedMapBase(const TR &b) : TR(b) {}
1245 1235
    };
1246 1236
    ///\brief \ref named-func-param "Named parameter"
1247 1237
    ///for setting \ref ProcessedMap object.
1248 1238
    ///
1249 1239
    /// \ref named-func-param "Named parameter"
1250 1240
    ///for setting \ref ProcessedMap object.
1251 1241
    template<class T>
1252 1242
    DijkstraWizard<SetProcessedMapBase<T> > processedMap(const T &t)
1253 1243
    {
1254 1244
      Base::_processed=reinterpret_cast<void*>(const_cast<T*>(&t));
1255 1245
      return DijkstraWizard<SetProcessedMapBase<T> >(*this);
1256 1246
    }
1257 1247

	
1258 1248
    template<class T>
1259 1249
    struct SetPathBase : public Base {
1260 1250
      typedef T Path;
1261 1251
      SetPathBase(const TR &b) : TR(b) {}
1262 1252
    };
1263 1253
    ///\brief \ref named-func-param "Named parameter"
1264 1254
    ///for getting the shortest path to the target node.
1265 1255
    ///
1266 1256
    ///\ref named-func-param "Named parameter"
1267 1257
    ///for getting the shortest path to the target node.
1268 1258
    template<class T>
1269 1259
    DijkstraWizard<SetPathBase<T> > path(const T &t)
1270 1260
    {
1271 1261
      Base::_path=reinterpret_cast<void*>(const_cast<T*>(&t));
1272 1262
      return DijkstraWizard<SetPathBase<T> >(*this);
1273 1263
    }
1274 1264

	
1275 1265
    ///\brief \ref named-func-param "Named parameter"
1276 1266
    ///for getting the distance of the target node.
1277 1267
    ///
1278 1268
    ///\ref named-func-param "Named parameter"
1279 1269
    ///for getting the distance of the target node.
1280 1270
    DijkstraWizard dist(const Value &d)
1281 1271
    {
1282 1272
      Base::_di=reinterpret_cast<void*>(const_cast<Value*>(&d));
1283 1273
      return *this;
1284 1274
    }
1285 1275

	
1286 1276
  };
1287 1277

	
1288 1278
  ///Function-type interface for Dijkstra algorithm.
1289 1279

	
1290 1280
  /// \ingroup shortest_path
1291 1281
  ///Function-type interface for Dijkstra algorithm.
1292 1282
  ///
1293 1283
  ///This function also has several \ref named-func-param "named parameters",
1294 1284
  ///they are declared as the members of class \ref DijkstraWizard.
1295 1285
  ///The following examples show how to use these parameters.
1296 1286
  ///\code
1297 1287
  ///  // Compute shortest path from node s to each node
1298 1288
  ///  dijkstra(g,length).predMap(preds).distMap(dists).run(s);
1299 1289
  ///
1300 1290
  ///  // Compute shortest path from s to t
1301 1291
  ///  bool reached = dijkstra(g,length).path(p).dist(d).run(s,t);
1302 1292
  ///\endcode
1303 1293
  ///\warning Don't forget to put the \ref DijkstraWizard::run() "run()"
1304 1294
  ///to the end of the parameter list.
1305 1295
  ///\sa DijkstraWizard
1306 1296
  ///\sa Dijkstra
1307 1297
  template<class GR, class LM>
1308 1298
  DijkstraWizard<DijkstraWizardBase<GR,LM> >
1309 1299
  dijkstra(const GR &digraph, const LM &length)
1310 1300
  {
1311 1301
    return DijkstraWizard<DijkstraWizardBase<GR,LM> >(digraph,length);
1312 1302
  }
1313 1303

	
1314 1304
} //END OF NAMESPACE LEMON
1315 1305

	
1316 1306
#endif
Ignore white space 768 line context
1 1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
2 2
 *
3 3
 * This file is a part of LEMON, a generic C++ optimization library.
4 4
 *
5 5
 * Copyright (C) 2003-2008
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_ERROR_H
20 20
#define LEMON_ERROR_H
21 21

	
22 22
/// \ingroup exceptions
23 23
/// \file
24 24
/// \brief Basic exception classes and error handling.
25 25

	
26 26
#include <exception>
27 27
#include <string>
28 28
#include <sstream>
29 29
#include <iostream>
30 30
#include <cstdlib>
31 31
#include <memory>
32 32

	
33 33
namespace lemon {
34 34

	
35 35
  /// \addtogroup exceptions
36 36
  /// @{
37 37

	
38 38
  /// \brief Exception safe wrapper class.
39 39
  ///
40 40
  /// Exception safe wrapper class to implement the members of exceptions.
41 41
  template <typename _Type>
42 42
  class ExceptionMember {
43 43
  public:
44 44
    typedef _Type Type;
45 45

	
46 46
    ExceptionMember() throw() {
47 47
      try {
48 48
        ptr.reset(new Type());
49 49
      } catch (...) {}
50 50
    }
51 51

	
52 52
    ExceptionMember(const Type& type) throw() {
53 53
      try {
54 54
        ptr.reset(new Type());
55 55
        if (ptr.get() == 0) return;
56 56
        *ptr = type;
57 57
      } catch (...) {}
58 58
    }
59 59

	
60 60
    ExceptionMember(const ExceptionMember& copy) throw() {
61 61
      try {
62 62
        if (!copy.valid()) return;
63 63
        ptr.reset(new Type());
64 64
        if (ptr.get() == 0) return;
65 65
        *ptr = copy.get();
66 66
      } catch (...) {}
67 67
    }
68 68

	
69 69
    ExceptionMember& operator=(const ExceptionMember& copy) throw() {
70 70
      if (ptr.get() == 0) return;
71 71
      try {
72 72
        if (!copy.valid()) return;
73 73
        *ptr = copy.get();
74 74
      } catch (...) {}
75 75
    }
76 76

	
77 77
    void set(const Type& type) throw() {
78 78
      if (ptr.get() == 0) return;
79 79
      try {
80 80
        *ptr = type;
81 81
      } catch (...) {}
82 82
    }
83 83

	
84 84
    const Type& get() const {
85 85
      return *ptr;
86 86
    }
87 87

	
88 88
    bool valid() const throw() {
89 89
      return ptr.get() != 0;
90 90
    }
91 91

	
92 92
  private:
93 93
    std::auto_ptr<_Type> ptr;
94 94
  };
95 95

	
96 96
  /// Exception-safe convenient error message builder class.
97 97

	
98 98
  /// Helper class which provides a convenient ostream-like (operator <<
99 99
  /// based) interface to create a string message. Mostly useful in
100 100
  /// exception classes (therefore the name).
101 101
  class ErrorMessage {
102 102
  protected:
103 103
    ///\e
104 104

	
105
    ///\todo The good solution is boost::shared_ptr...
106
    ///
107 105
    mutable std::auto_ptr<std::ostringstream> buf;
108 106

	
109 107
    ///\e
110 108
    bool init() throw() {
111 109
      try {
112 110
        buf.reset(new std::ostringstream);
113 111
      }
114 112
      catch(...) {
115 113
        buf.reset();
116 114
      }
117 115
      return buf.get();
118 116
    }
119 117

	
120 118
  public:
121 119

	
122 120
    ///\e
123 121
    ErrorMessage() throw() { init(); }
124 122

	
125 123
    ErrorMessage(const ErrorMessage& em) throw() : buf(em.buf) { }
126 124

	
127 125
    ///\e
128 126
    ErrorMessage(const char *msg) throw() {
129 127
      init();
130 128
      *this << msg;
131 129
    }
132 130

	
133 131
    ///\e
134 132
    ErrorMessage(const std::string &msg) throw() {
135 133
      init();
136 134
      *this << msg;
137 135
    }
138 136

	
139 137
    ///\e
140 138
    template <typename T>
141 139
    ErrorMessage& operator<<(const T &t) throw() {
142 140
      if( ! buf.get() ) return *this;
143 141

	
144 142
      try {
145 143
        *buf << t;
146 144
      }
147 145
      catch(...) {
148 146
        buf.reset();
149 147
      }
150 148
      return *this;
151 149
    }
152 150

	
153 151
    ///\e
154 152
    const char* message() throw() {
155 153
      if( ! buf.get() ) return 0;
156 154

	
157 155
      const char* mes = 0;
158 156
      try {
159 157
        mes = buf->str().c_str();
160 158
      }
161 159
      catch(...) {}
162 160
      return mes;
163 161
    }
164 162

	
165 163
  };
166 164

	
167 165
  /// Generic exception class.
168 166

	
169 167
  /// Base class for exceptions used in LEMON.
170 168
  ///
171 169
  class Exception : public std::exception {
172 170
  public:
173 171
    ///\e
174 172
    Exception() {}
175 173
    ///\e
176 174
    virtual ~Exception() throw() {}
177 175
    ///\e
178 176
    virtual const char* what() const throw() {
179 177
      return "lemon::Exception";
180 178
    }
181 179
  };
182 180

	
183 181
  /// One of the two main subclasses of \ref Exception.
184 182

	
185 183
  /// Logic errors represent problems in the internal logic of a program;
186 184
  /// in theory, these are preventable, and even detectable before the
187 185
  /// program runs (e.g. violations of class invariants).
188 186
  ///
189 187
  /// A typical example for this is \ref UninitializedParameter.
190 188
  class LogicError : public Exception {
191 189
  public:
192 190
    virtual const char* what() const throw() {
193 191
      return "lemon::LogicError";
194 192
    }
195 193
  };
196 194

	
197 195
  /// \ref Exception for uninitialized parameters.
198 196

	
199 197
  /// This error represents problems in the initialization
200 198
  /// of the parameters of the algorithms.
201 199
  class UninitializedParameter : public LogicError {
202 200
  public:
203 201
    virtual const char* what() const throw() {
204 202
      return "lemon::UninitializedParameter";
205 203
    }
206 204
  };
207 205

	
208 206

	
209 207
  /// One of the two main subclasses of \ref Exception.
210 208

	
211 209
  /// Runtime errors represent problems outside the scope of a program;
212 210
  /// they cannot be easily predicted and can generally only be caught
213 211
  /// as the program executes.
214 212
  class RuntimeError : public Exception {
215 213
  public:
216 214
    virtual const char* what() const throw() {
217 215
      return "lemon::RuntimeError";
218 216
    }
219 217
  };
220 218

	
221 219
  ///\e
222 220
  class RangeError : public RuntimeError {
223 221
  public:
224 222
    virtual const char* what() const throw() {
225 223
      return "lemon::RangeError";
226 224
    }
227 225
  };
228 226

	
229 227
  ///\e
230 228
  class IoError : public RuntimeError {
231 229
  public:
232 230
    virtual const char* what() const throw() {
233 231
      return "lemon::IoError";
234 232
    }
235 233
  };
236 234

	
237 235
  ///\e
238 236
  class DataFormatError : public IoError {
239 237
  protected:
240 238
    ExceptionMember<std::string> _message;
241 239
    ExceptionMember<std::string> _file;
242 240
    int _line;
243 241

	
244 242
    mutable ExceptionMember<std::string> _message_holder;
245 243
  public:
246 244

	
247 245
    DataFormatError(const DataFormatError &dfe) :
248 246
      IoError(dfe), _message(dfe._message), _file(dfe._file),
249 247
      _line(dfe._line) {}
250 248

	
251 249
    ///\e
252 250
    explicit DataFormatError(const char *the_message)
253 251
      : _message(the_message), _line(0) {}
254 252

	
255 253
    ///\e
256 254
    DataFormatError(const std::string &file_name, int line_num,
257 255
                    const char *the_message)
258 256
      : _message(the_message), _line(line_num) { file(file_name); }
259 257

	
260 258
    ///\e
261 259
    void line(int ln) { _line = ln; }
262 260
    ///\e
263 261
    void message(const std::string& msg) { _message.set(msg); }
264 262
    ///\e
265 263
    void file(const std::string &fl) { _file.set(fl); }
266 264

	
267 265
    ///\e
268 266
    int line() const { return _line; }
269 267
    ///\e
270 268
    const char* message() const {
271 269
      if (_message.valid() && !_message.get().empty()) {
272 270
        return _message.get().c_str();
273 271
      } else {
274 272
        return 0;
275 273
      }
276 274
    }
277 275

	
278 276
    /// \brief Returns the filename.
279 277
    ///
280 278
    /// Returns \e null if the filename was not specified.
281 279
    const char* file() const {
282 280
      if (_file.valid() && !_file.get().empty()) {
283 281
        return _file.get().c_str();
284 282
      } else {
285 283
        return 0;
286 284
      }
287 285
    }
288 286

	
289 287
    ///\e
290 288
    virtual const char* what() const throw() {
291 289
      try {
292 290
        std::ostringstream ostr;
293 291
        ostr << "lemon:DataFormatError" << ": ";
294 292
        if (message()) ostr << message();
295 293
        if( file() || line() != 0 ) {
296 294
          ostr << " (";
297 295
          if( file() ) ostr << "in file '" << file() << "'";
298 296
          if( file() && line() != 0 ) ostr << " ";
299 297
          if( line() != 0 ) ostr << "at line " << line();
300 298
          ostr << ")";
301 299
        }
302 300
        _message_holder.set(ostr.str());
303 301
      }
304 302
      catch (...) {}
305 303
      if( _message_holder.valid()) return _message_holder.get().c_str();
306 304
      return "lemon:DataFormatError";
307 305
    }
308 306

	
309 307
    virtual ~DataFormatError() throw() {}
310 308
  };
311 309

	
312 310
  ///\e
313 311
  class FileOpenError : public IoError {
314 312
  protected:
315 313
    ExceptionMember<std::string> _file;
316 314

	
317 315
    mutable ExceptionMember<std::string> _message_holder;
318 316
  public:
319 317

	
320 318
    FileOpenError(const FileOpenError &foe) :
321 319
      IoError(foe), _file(foe._file) {}
322 320

	
323 321
    ///\e
324 322
    explicit FileOpenError(const std::string& fl)
325 323
      : _file(fl) {}
326 324

	
327 325

	
328 326
    ///\e
329 327
    void file(const std::string &fl) { _file.set(fl); }
330 328

	
331 329
    /// \brief Returns the filename.
332 330
    ///
333 331
    /// Returns \e null if the filename was not specified.
334 332
    const char* file() const {
335 333
      if (_file.valid() && !_file.get().empty()) {
336 334
        return _file.get().c_str();
337 335
      } else {
338 336
        return 0;
339 337
      }
340 338
    }
341 339

	
342 340
    ///\e
343 341
    virtual const char* what() const throw() {
344 342
      try {
345 343
        std::ostringstream ostr;
346 344
        ostr << "lemon::FileOpenError" << ": ";
347 345
        ostr << "Cannot open file - " << file();
348 346
        _message_holder.set(ostr.str());
349 347
      }
350 348
      catch (...) {}
351 349
      if( _message_holder.valid()) return _message_holder.get().c_str();
352 350
      return "lemon::FileOpenError";
353 351
    }
354 352
    virtual ~FileOpenError() throw() {}
355 353
  };
356 354

	
357 355
  class IoParameterError : public IoError {
358 356
  protected:
359 357
    ExceptionMember<std::string> _message;
360 358
    ExceptionMember<std::string> _file;
361 359

	
362 360
    mutable ExceptionMember<std::string> _message_holder;
363 361
  public:
364 362

	
365 363
    IoParameterError(const IoParameterError &ile) :
366 364
      IoError(ile), _message(ile._message), _file(ile._file) {}
367 365

	
368 366
    ///\e
369 367
    explicit IoParameterError(const char *the_message)
370 368
      : _message(the_message) {}
371 369

	
372 370
    ///\e
373 371
    IoParameterError(const char *file_name, const char *the_message)
374 372
      : _message(the_message), _file(file_name) {}
375 373

	
376 374
     ///\e
377 375
    void message(const std::string& msg) { _message.set(msg); }
378 376
    ///\e
379 377
    void file(const std::string &fl) { _file.set(fl); }
380 378

	
381 379
     ///\e
382 380
    const char* message() const {
383 381
      if (_message.valid()) {
384 382
        return _message.get().c_str();
385 383
      } else {
386 384
        return 0;
387 385
      }
388 386
    }
389 387

	
390 388
    /// \brief Returns the filename.
391 389
    ///
392 390
    /// Returns \c 0 if the filename was not specified.
393 391
    const char* file() const {
394 392
      if (_file.valid()) {
395 393
        return _file.get().c_str();
396 394
      } else {
397 395
        return 0;
398 396
      }
399 397
    }
400 398

	
401 399
    ///\e
402 400
    virtual const char* what() const throw() {
403 401
      try {
404 402
        std::ostringstream ostr;
405 403
        if (message()) ostr << message();
406 404
        if (file()) ostr << "(when reading file '" << file() << "')";
407 405
        _message_holder.set(ostr.str());
408 406
      }
409 407
      catch (...) {}
410 408
      if( _message_holder.valid() ) return _message_holder.get().c_str();
411 409
      return "lemon:IoParameterError";
412 410
    }
413 411
    virtual ~IoParameterError() throw() {}
414 412
  };
415 413

	
416 414
  /// @}
417 415

	
418 416
}
419 417

	
420 418
#endif // LEMON_ERROR_H
Ignore white space 6 line context
... ...
@@ -285,912 +285,907 @@
285 285
    /// = 4
286 286
    ///\image html nodeshape_4.png
287 287
    ///\image latex nodeshape_2.eps "FEMALE shape (4)" width=2cm
288 288
    ///
289 289
    FEMALE=4
290 290
  };
291 291

	
292 292
private:
293 293
  class arcLess {
294 294
    const Graph &g;
295 295
  public:
296 296
    arcLess(const Graph &_g) : g(_g) {}
297 297
    bool operator()(Arc a,Arc b) const
298 298
    {
299 299
      Node ai=std::min(g.source(a),g.target(a));
300 300
      Node aa=std::max(g.source(a),g.target(a));
301 301
      Node bi=std::min(g.source(b),g.target(b));
302 302
      Node ba=std::max(g.source(b),g.target(b));
303 303
      return ai<bi ||
304 304
        (ai==bi && (aa < ba ||
305 305
                    (aa==ba && ai==g.source(a) && bi==g.target(b))));
306 306
    }
307 307
  };
308 308
  bool isParallel(Arc e,Arc f) const
309 309
  {
310 310
    return (g.source(e)==g.source(f)&&
311 311
            g.target(e)==g.target(f)) ||
312 312
      (g.source(e)==g.target(f)&&
313 313
       g.target(e)==g.source(f));
314 314
  }
315 315
  template<class TT>
316 316
  static std::string psOut(const dim2::Point<TT> &p)
317 317
    {
318 318
      std::ostringstream os;
319 319
      os << p.x << ' ' << p.y;
320 320
      return os.str();
321 321
    }
322 322
  static std::string psOut(const Color &c)
323 323
    {
324 324
      std::ostringstream os;
325 325
      os << c.red() << ' ' << c.green() << ' ' << c.blue();
326 326
      return os.str();
327 327
    }
328 328

	
329 329
public:
330 330
  GraphToEps(const T &t) : T(t), dontPrint(false) {};
331 331

	
332 332
  template<class X> struct CoordsTraits : public T {
333 333
  typedef X CoordsMapType;
334 334
    const X &_coords;
335 335
    CoordsTraits(const T &t,const X &x) : T(t), _coords(x) {}
336 336
  };
337 337
  ///Sets the map of the node coordinates
338 338

	
339 339
  ///Sets the map of the node coordinates.
340 340
  ///\param x must be a node map with \ref dim2::Point "dim2::Point<double>" or
341 341
  ///\ref dim2::Point "dim2::Point<int>" values.
342 342
  template<class X> GraphToEps<CoordsTraits<X> > coords(const X &x) {
343 343
    dontPrint=true;
344 344
    return GraphToEps<CoordsTraits<X> >(CoordsTraits<X>(*this,x));
345 345
  }
346 346
  template<class X> struct NodeSizesTraits : public T {
347 347
    const X &_nodeSizes;
348 348
    NodeSizesTraits(const T &t,const X &x) : T(t), _nodeSizes(x) {}
349 349
  };
350 350
  ///Sets the map of the node sizes
351 351

	
352 352
  ///Sets the map of the node sizes.
353 353
  ///\param x must be a node map with \c double (or convertible) values.
354 354
  template<class X> GraphToEps<NodeSizesTraits<X> > nodeSizes(const X &x)
355 355
  {
356 356
    dontPrint=true;
357 357
    return GraphToEps<NodeSizesTraits<X> >(NodeSizesTraits<X>(*this,x));
358 358
  }
359 359
  template<class X> struct NodeShapesTraits : public T {
360 360
    const X &_nodeShapes;
361 361
    NodeShapesTraits(const T &t,const X &x) : T(t), _nodeShapes(x) {}
362 362
  };
363 363
  ///Sets the map of the node shapes
364 364

	
365 365
  ///Sets the map of the node shapes.
366 366
  ///The available shape values
367 367
  ///can be found in \ref NodeShapes "enum NodeShapes".
368 368
  ///\param x must be a node map with \c int (or convertible) values.
369 369
  ///\sa NodeShapes
370 370
  template<class X> GraphToEps<NodeShapesTraits<X> > nodeShapes(const X &x)
371 371
  {
372 372
    dontPrint=true;
373 373
    return GraphToEps<NodeShapesTraits<X> >(NodeShapesTraits<X>(*this,x));
374 374
  }
375 375
  template<class X> struct NodeTextsTraits : public T {
376 376
    const X &_nodeTexts;
377 377
    NodeTextsTraits(const T &t,const X &x) : T(t), _nodeTexts(x) {}
378 378
  };
379 379
  ///Sets the text printed on the nodes
380 380

	
381 381
  ///Sets the text printed on the nodes.
382 382
  ///\param x must be a node map with type that can be pushed to a standard
383 383
  ///\c ostream.
384 384
  template<class X> GraphToEps<NodeTextsTraits<X> > nodeTexts(const X &x)
385 385
  {
386 386
    dontPrint=true;
387 387
    _showNodeText=true;
388 388
    return GraphToEps<NodeTextsTraits<X> >(NodeTextsTraits<X>(*this,x));
389 389
  }
390 390
  template<class X> struct NodePsTextsTraits : public T {
391 391
    const X &_nodePsTexts;
392 392
    NodePsTextsTraits(const T &t,const X &x) : T(t), _nodePsTexts(x) {}
393 393
  };
394 394
  ///Inserts a PostScript block to the nodes
395 395

	
396 396
  ///With this command it is possible to insert a verbatim PostScript
397 397
  ///block to the nodes.
398 398
  ///The PS current point will be moved to the center of the node before
399 399
  ///the PostScript block inserted.
400 400
  ///
401 401
  ///Before and after the block a newline character is inserted so you
402 402
  ///don't have to bother with the separators.
403 403
  ///
404 404
  ///\param x must be a node map with type that can be pushed to a standard
405 405
  ///\c ostream.
406 406
  ///
407 407
  ///\sa nodePsTextsPreamble()
408 408
  template<class X> GraphToEps<NodePsTextsTraits<X> > nodePsTexts(const X &x)
409 409
  {
410 410
    dontPrint=true;
411 411
    _showNodePsText=true;
412 412
    return GraphToEps<NodePsTextsTraits<X> >(NodePsTextsTraits<X>(*this,x));
413 413
  }
414 414
  template<class X> struct ArcWidthsTraits : public T {
415 415
    const X &_arcWidths;
416 416
    ArcWidthsTraits(const T &t,const X &x) : T(t), _arcWidths(x) {}
417 417
  };
418 418
  ///Sets the map of the arc widths
419 419

	
420 420
  ///Sets the map of the arc widths.
421 421
  ///\param x must be an arc map with \c double (or convertible) values.
422 422
  template<class X> GraphToEps<ArcWidthsTraits<X> > arcWidths(const X &x)
423 423
  {
424 424
    dontPrint=true;
425 425
    return GraphToEps<ArcWidthsTraits<X> >(ArcWidthsTraits<X>(*this,x));
426 426
  }
427 427

	
428 428
  template<class X> struct NodeColorsTraits : public T {
429 429
    const X &_nodeColors;
430 430
    NodeColorsTraits(const T &t,const X &x) : T(t), _nodeColors(x) {}
431 431
  };
432 432
  ///Sets the map of the node colors
433 433

	
434 434
  ///Sets the map of the node colors.
435 435
  ///\param x must be a node map with \ref Color values.
436 436
  ///
437 437
  ///\sa Palette
438 438
  template<class X> GraphToEps<NodeColorsTraits<X> >
439 439
  nodeColors(const X &x)
440 440
  {
441 441
    dontPrint=true;
442 442
    return GraphToEps<NodeColorsTraits<X> >(NodeColorsTraits<X>(*this,x));
443 443
  }
444 444
  template<class X> struct NodeTextColorsTraits : public T {
445 445
    const X &_nodeTextColors;
446 446
    NodeTextColorsTraits(const T &t,const X &x) : T(t), _nodeTextColors(x) {}
447 447
  };
448 448
  ///Sets the map of the node text colors
449 449

	
450 450
  ///Sets the map of the node text colors.
451 451
  ///\param x must be a node map with \ref Color values.
452 452
  ///
453 453
  ///\sa Palette
454 454
  template<class X> GraphToEps<NodeTextColorsTraits<X> >
455 455
  nodeTextColors(const X &x)
456 456
  {
457 457
    dontPrint=true;
458 458
    _nodeTextColorType=CUST_COL;
459 459
    return GraphToEps<NodeTextColorsTraits<X> >
460 460
      (NodeTextColorsTraits<X>(*this,x));
461 461
  }
462 462
  template<class X> struct ArcColorsTraits : public T {
463 463
    const X &_arcColors;
464 464
    ArcColorsTraits(const T &t,const X &x) : T(t), _arcColors(x) {}
465 465
  };
466 466
  ///Sets the map of the arc colors
467 467

	
468 468
  ///Sets the map of the arc colors.
469 469
  ///\param x must be an arc map with \ref Color values.
470 470
  ///
471 471
  ///\sa Palette
472 472
  template<class X> GraphToEps<ArcColorsTraits<X> >
473 473
  arcColors(const X &x)
474 474
  {
475 475
    dontPrint=true;
476 476
    return GraphToEps<ArcColorsTraits<X> >(ArcColorsTraits<X>(*this,x));
477 477
  }
478 478
  ///Sets a global scale factor for node sizes
479 479

	
480 480
  ///Sets a global scale factor for node sizes.
481 481
  ///
482 482
  /// If nodeSizes() is not given, this function simply sets the node
483 483
  /// sizes to \c d.  If nodeSizes() is given, but
484 484
  /// autoNodeScale() is not, then the node size given by
485 485
  /// nodeSizes() will be multiplied by the value \c d.
486 486
  /// If both nodeSizes() and autoNodeScale() are used, then the
487 487
  /// node sizes will be scaled in such a way that the greatest size will be
488 488
  /// equal to \c d.
489 489
  /// \sa nodeSizes()
490 490
  /// \sa autoNodeScale()
491 491
  GraphToEps<T> &nodeScale(double d=.01) {_nodeScale=d;return *this;}
492 492
  ///Turns on/off the automatic node size scaling.
493 493

	
494 494
  ///Turns on/off the automatic node size scaling.
495 495
  ///
496 496
  ///\sa nodeScale()
497 497
  ///
498 498
  GraphToEps<T> &autoNodeScale(bool b=true) {
499 499
    _autoNodeScale=b;return *this;
500 500
  }
501 501

	
502 502
  ///Turns on/off the absolutematic node size scaling.
503 503

	
504 504
  ///Turns on/off the absolutematic node size scaling.
505 505
  ///
506 506
  ///\sa nodeScale()
507 507
  ///
508 508
  GraphToEps<T> &absoluteNodeSizes(bool b=true) {
509 509
    _absoluteNodeSizes=b;return *this;
510 510
  }
511 511

	
512 512
  ///Negates the Y coordinates.
513 513
  GraphToEps<T> &negateY(bool b=true) {
514 514
    _negY=b;return *this;
515 515
  }
516 516

	
517 517
  ///Turn on/off pre-scaling
518 518

	
519 519
  ///By default graphToEps() rescales the whole image in order to avoid
520 520
  ///very big or very small bounding boxes.
521 521
  ///
522 522
  ///This (p)rescaling can be turned off with this function.
523 523
  ///
524 524
  GraphToEps<T> &preScale(bool b=true) {
525 525
    _preScale=b;return *this;
526 526
  }
527 527

	
528 528
  ///Sets a global scale factor for arc widths
529 529

	
530 530
  /// Sets a global scale factor for arc widths.
531 531
  ///
532 532
  /// If arcWidths() is not given, this function simply sets the arc
533 533
  /// widths to \c d.  If arcWidths() is given, but
534 534
  /// autoArcWidthScale() is not, then the arc withs given by
535 535
  /// arcWidths() will be multiplied by the value \c d.
536 536
  /// If both arcWidths() and autoArcWidthScale() are used, then the
537 537
  /// arc withs will be scaled in such a way that the greatest width will be
538 538
  /// equal to \c d.
539 539
  GraphToEps<T> &arcWidthScale(double d=.003) {_arcWidthScale=d;return *this;}
540 540
  ///Turns on/off the automatic arc width scaling.
541 541

	
542 542
  ///Turns on/off the automatic arc width scaling.
543 543
  ///
544 544
  ///\sa arcWidthScale()
545 545
  ///
546 546
  GraphToEps<T> &autoArcWidthScale(bool b=true) {
547 547
    _autoArcWidthScale=b;return *this;
548 548
  }
549 549
  ///Turns on/off the absolutematic arc width scaling.
550 550

	
551 551
  ///Turns on/off the absolutematic arc width scaling.
552 552
  ///
553 553
  ///\sa arcWidthScale()
554 554
  ///
555 555
  GraphToEps<T> &absoluteArcWidths(bool b=true) {
556 556
    _absoluteArcWidths=b;return *this;
557 557
  }
558 558
  ///Sets a global scale factor for the whole picture
559 559
  GraphToEps<T> &scale(double d) {_scale=d;return *this;}
560 560
  ///Sets the width of the border around the picture
561 561
  GraphToEps<T> &border(double b=10) {_xBorder=_yBorder=b;return *this;}
562 562
  ///Sets the width of the border around the picture
563 563
  GraphToEps<T> &border(double x, double y) {
564 564
    _xBorder=x;_yBorder=y;return *this;
565 565
  }
566 566
  ///Sets whether to draw arrows
567 567
  GraphToEps<T> &drawArrows(bool b=true) {_drawArrows=b;return *this;}
568 568
  ///Sets the length of the arrowheads
569 569
  GraphToEps<T> &arrowLength(double d=1.0) {_arrowLength*=d;return *this;}
570 570
  ///Sets the width of the arrowheads
571 571
  GraphToEps<T> &arrowWidth(double d=.3) {_arrowWidth*=d;return *this;}
572 572

	
573 573
  ///Scales the drawing to fit to A4 page
574 574
  GraphToEps<T> &scaleToA4() {_scaleToA4=true;return *this;}
575 575

	
576 576
  ///Enables parallel arcs
577 577
  GraphToEps<T> &enableParallel(bool b=true) {_enableParallel=b;return *this;}
578 578

	
579 579
  ///Sets the distance between parallel arcs
580 580
  GraphToEps<T> &parArcDist(double d) {_parArcDist*=d;return *this;}
581 581

	
582 582
  ///Hides the arcs
583 583
  GraphToEps<T> &hideArcs(bool b=true) {_showArcs=!b;return *this;}
584 584
  ///Hides the nodes
585 585
  GraphToEps<T> &hideNodes(bool b=true) {_showNodes=!b;return *this;}
586 586

	
587 587
  ///Sets the size of the node texts
588 588
  GraphToEps<T> &nodeTextSize(double d) {_nodeTextSize=d;return *this;}
589 589

	
590 590
  ///Sets the color of the node texts to be different from the node color
591 591

	
592 592
  ///Sets the color of the node texts to be as different from the node color
593 593
  ///as it is possible.
594 594
  GraphToEps<T> &distantColorNodeTexts()
595 595
  {_nodeTextColorType=DIST_COL;return *this;}
596 596
  ///Sets the color of the node texts to be black or white and always visible.
597 597

	
598 598
  ///Sets the color of the node texts to be black or white according to
599 599
  ///which is more different from the node color.
600 600
  GraphToEps<T> &distantBWNodeTexts()
601 601
  {_nodeTextColorType=DIST_BW;return *this;}
602 602

	
603 603
  ///Gives a preamble block for node Postscript block.
604 604

	
605 605
  ///Gives a preamble block for node Postscript block.
606 606
  ///
607 607
  ///\sa nodePsTexts()
608 608
  GraphToEps<T> & nodePsTextsPreamble(const char *str) {
609 609
    _nodePsTextsPreamble=str ;return *this;
610 610
  }
611 611
  ///Sets whether the graph is undirected
612 612

	
613 613
  ///Sets whether the graph is undirected.
614 614
  ///
615 615
  ///This setting is the default for undirected graphs.
616 616
  ///
617 617
  ///\sa directed()
618 618
   GraphToEps<T> &undirected(bool b=true) {_undirected=b;return *this;}
619 619

	
620 620
  ///Sets whether the graph is directed
621 621

	
622 622
  ///Sets whether the graph is directed.
623 623
  ///Use it to show the edges as a pair of directed ones.
624 624
  ///
625 625
  ///This setting is the default for digraphs.
626 626
  ///
627 627
  ///\sa undirected()
628 628
  GraphToEps<T> &directed(bool b=true) {_undirected=!b;return *this;}
629 629

	
630 630
  ///Sets the title.
631 631

	
632 632
  ///Sets the title of the generated image,
633 633
  ///namely it inserts a <tt>%%Title:</tt> DSC field to the header of
634 634
  ///the EPS file.
635 635
  GraphToEps<T> &title(const std::string &t) {_title=t;return *this;}
636 636
  ///Sets the copyright statement.
637 637

	
638 638
  ///Sets the copyright statement of the generated image,
639 639
  ///namely it inserts a <tt>%%Copyright:</tt> DSC field to the header of
640 640
  ///the EPS file.
641 641
  GraphToEps<T> &copyright(const std::string &t) {_copyright=t;return *this;}
642 642

	
643 643
protected:
644 644
  bool isInsideNode(dim2::Point<double> p, double r,int t)
645 645
  {
646 646
    switch(t) {
647 647
    case CIRCLE:
648 648
    case MALE:
649 649
    case FEMALE:
650 650
      return p.normSquare()<=r*r;
651 651
    case SQUARE:
652 652
      return p.x<=r&&p.x>=-r&&p.y<=r&&p.y>=-r;
653 653
    case DIAMOND:
654 654
      return p.x+p.y<=r && p.x-p.y<=r && -p.x+p.y<=r && -p.x-p.y<=r;
655 655
    }
656 656
    return false;
657 657
  }
658 658

	
659 659
public:
660 660
  ~GraphToEps() { }
661 661

	
662 662
  ///Draws the graph.
663 663

	
664 664
  ///Like other functions using
665 665
  ///\ref named-templ-func-param "named template parameters",
666 666
  ///this function calls the algorithm itself, i.e. in this case
667 667
  ///it draws the graph.
668 668
  void run() {
669
    //\todo better 'epsilon' would be nice here.
670 669
    const double EPSILON=1e-9;
671 670
    if(dontPrint) return;
672 671

	
673 672
    _graph_to_eps_bits::_NegY<typename T::CoordsMapType>
674 673
      mycoords(_coords,_negY);
675 674

	
676 675
    os << "%!PS-Adobe-2.0 EPSF-2.0\n";
677 676
    if(_title.size()>0) os << "%%Title: " << _title << '\n';
678 677
     if(_copyright.size()>0) os << "%%Copyright: " << _copyright << '\n';
679 678
    os << "%%Creator: LEMON, graphToEps()\n";
680 679

	
681 680
    {
682 681
#ifndef WIN32
683 682
      timeval tv;
684 683
      gettimeofday(&tv, 0);
685 684

	
686 685
      char cbuf[26];
687 686
      ctime_r(&tv.tv_sec,cbuf);
688 687
      os << "%%CreationDate: " << cbuf;
689 688
#else
690 689
      SYSTEMTIME time;
691 690
      char buf1[11], buf2[9], buf3[5];
692 691

	
693 692
      GetSystemTime(&time);
694 693
      if (GetDateFormat(LOCALE_USER_DEFAULT, 0, &time,
695 694
                        "ddd MMM dd", buf1, 11) &&
696 695
          GetTimeFormat(LOCALE_USER_DEFAULT, 0, &time,
697 696
                        "HH':'mm':'ss", buf2, 9) &&
698 697
          GetDateFormat(LOCALE_USER_DEFAULT, 0, &time,
699 698
                                "yyyy", buf3, 5)) {
700 699
        os << "%%CreationDate: " << buf1 << ' '
701 700
           << buf2 << ' ' << buf3 << std::endl;
702 701
      }
703 702
#endif
704 703
    }
705 704

	
706 705
    if (_autoArcWidthScale) {
707 706
      double max_w=0;
708 707
      for(ArcIt e(g);e!=INVALID;++e)
709 708
        max_w=std::max(double(_arcWidths[e]),max_w);
710
      //\todo better 'epsilon' would be nice here.
711 709
      if(max_w>EPSILON) {
712 710
        _arcWidthScale/=max_w;
713 711
      }
714 712
    }
715 713

	
716 714
    if (_autoNodeScale) {
717 715
      double max_s=0;
718 716
      for(NodeIt n(g);n!=INVALID;++n)
719 717
        max_s=std::max(double(_nodeSizes[n]),max_s);
720
      //\todo better 'epsilon' would be nice here.
721 718
      if(max_s>EPSILON) {
722 719
        _nodeScale/=max_s;
723 720
      }
724 721
    }
725 722

	
726 723
    double diag_len = 1;
727 724
    if(!(_absoluteNodeSizes&&_absoluteArcWidths)) {
728 725
      dim2::Box<double> bb;
729 726
      for(NodeIt n(g);n!=INVALID;++n) bb.add(mycoords[n]);
730 727
      if (bb.empty()) {
731 728
        bb = dim2::Box<double>(dim2::Point<double>(0,0));
732 729
      }
733 730
      diag_len = std::sqrt((bb.bottomLeft()-bb.topRight()).normSquare());
734 731
      if(diag_len<EPSILON) diag_len = 1;
735 732
      if(!_absoluteNodeSizes) _nodeScale*=diag_len;
736 733
      if(!_absoluteArcWidths) _arcWidthScale*=diag_len;
737 734
    }
738 735

	
739 736
    dim2::Box<double> bb;
740 737
    for(NodeIt n(g);n!=INVALID;++n) {
741 738
      double ns=_nodeSizes[n]*_nodeScale;
742 739
      dim2::Point<double> p(ns,ns);
743 740
      switch(_nodeShapes[n]) {
744 741
      case CIRCLE:
745 742
      case SQUARE:
746 743
      case DIAMOND:
747 744
        bb.add(p+mycoords[n]);
748 745
        bb.add(-p+mycoords[n]);
749 746
        break;
750 747
      case MALE:
751 748
        bb.add(-p+mycoords[n]);
752 749
        bb.add(dim2::Point<double>(1.5*ns,1.5*std::sqrt(3.0)*ns)+mycoords[n]);
753 750
        break;
754 751
      case FEMALE:
755 752
        bb.add(p+mycoords[n]);
756 753
        bb.add(dim2::Point<double>(-ns,-3.01*ns)+mycoords[n]);
757 754
        break;
758 755
      }
759 756
    }
760 757
    if (bb.empty()) {
761 758
      bb = dim2::Box<double>(dim2::Point<double>(0,0));
762 759
    }
763 760

	
764 761
    if(_scaleToA4)
765 762
      os <<"%%BoundingBox: 0 0 596 842\n%%DocumentPaperSizes: a4\n";
766 763
    else {
767 764
      if(_preScale) {
768 765
        //Rescale so that BoundingBox won't be neither to big nor too small.
769 766
        while(bb.height()*_scale>1000||bb.width()*_scale>1000) _scale/=10;
770 767
        while(bb.height()*_scale<100||bb.width()*_scale<100) _scale*=10;
771 768
      }
772 769

	
773 770
      os << "%%BoundingBox: "
774 771
         << int(floor(bb.left()   * _scale - _xBorder)) << ' '
775 772
         << int(floor(bb.bottom() * _scale - _yBorder)) << ' '
776 773
         << int(ceil(bb.right()  * _scale + _xBorder)) << ' '
777 774
         << int(ceil(bb.top()    * _scale + _yBorder)) << '\n';
778 775
    }
779 776

	
780 777
    os << "%%EndComments\n";
781 778

	
782 779
    //x1 y1 x2 y2 x3 y3 cr cg cb w
783 780
    os << "/lb { setlinewidth setrgbcolor newpath moveto\n"
784 781
       << "      4 2 roll 1 index 1 index curveto stroke } bind def\n";
785 782
    os << "/l { setlinewidth setrgbcolor newpath moveto lineto stroke }"
786 783
       << " bind def\n";
787 784
    //x y r
788 785
    os << "/c { newpath dup 3 index add 2 index moveto 0 360 arc closepath }"
789 786
       << " bind def\n";
790 787
    //x y r
791 788
    os << "/sq { newpath 2 index 1 index add 2 index 2 index add moveto\n"
792 789
       << "      2 index 1 index sub 2 index 2 index add lineto\n"
793 790
       << "      2 index 1 index sub 2 index 2 index sub lineto\n"
794 791
       << "      2 index 1 index add 2 index 2 index sub lineto\n"
795 792
       << "      closepath pop pop pop} bind def\n";
796 793
    //x y r
797 794
    os << "/di { newpath 2 index 1 index add 2 index moveto\n"
798 795
       << "      2 index             2 index 2 index add lineto\n"
799 796
       << "      2 index 1 index sub 2 index             lineto\n"
800 797
       << "      2 index             2 index 2 index sub lineto\n"
801 798
       << "      closepath pop pop pop} bind def\n";
802 799
    // x y r cr cg cb
803 800
    os << "/nc { 0 0 0 setrgbcolor 5 index 5 index 5 index c fill\n"
804 801
       << "     setrgbcolor " << 1+_nodeBorderQuotient << " div c fill\n"
805 802
       << "   } bind def\n";
806 803
    os << "/nsq { 0 0 0 setrgbcolor 5 index 5 index 5 index sq fill\n"
807 804
       << "     setrgbcolor " << 1+_nodeBorderQuotient << " div sq fill\n"
808 805
       << "   } bind def\n";
809 806
    os << "/ndi { 0 0 0 setrgbcolor 5 index 5 index 5 index di fill\n"
810 807
       << "     setrgbcolor " << 1+_nodeBorderQuotient << " div di fill\n"
811 808
       << "   } bind def\n";
812 809
    os << "/nfemale { 0 0 0 setrgbcolor 3 index "
813 810
       << _nodeBorderQuotient/(1+_nodeBorderQuotient)
814 811
       << " 1.5 mul mul setlinewidth\n"
815 812
       << "  newpath 5 index 5 index moveto "
816 813
       << "5 index 5 index 5 index 3.01 mul sub\n"
817 814
       << "  lineto 5 index 4 index .7 mul sub 5 index 5 index 2.2 mul sub"
818 815
       << " moveto\n"
819 816
       << "  5 index 4 index .7 mul add 5 index 5 index 2.2 mul sub lineto "
820 817
       << "stroke\n"
821 818
       << "  5 index 5 index 5 index c fill\n"
822 819
       << "  setrgbcolor " << 1+_nodeBorderQuotient << " div c fill\n"
823 820
       << "  } bind def\n";
824 821
    os << "/nmale {\n"
825 822
       << "  0 0 0 setrgbcolor 3 index "
826 823
       << _nodeBorderQuotient/(1+_nodeBorderQuotient)
827 824
       <<" 1.5 mul mul setlinewidth\n"
828 825
       << "  newpath 5 index 5 index moveto\n"
829 826
       << "  5 index 4 index 1 mul 1.5 mul add\n"
830 827
       << "  5 index 5 index 3 sqrt 1.5 mul mul add\n"
831 828
       << "  1 index 1 index lineto\n"
832 829
       << "  1 index 1 index 7 index sub moveto\n"
833 830
       << "  1 index 1 index lineto\n"
834 831
       << "  exch 5 index 3 sqrt .5 mul mul sub exch 5 index .5 mul sub"
835 832
       << " lineto\n"
836 833
       << "  stroke\n"
837 834
       << "  5 index 5 index 5 index c fill\n"
838 835
       << "  setrgbcolor " << 1+_nodeBorderQuotient << " div c fill\n"
839 836
       << "  } bind def\n";
840 837

	
841 838

	
842 839
    os << "/arrl " << _arrowLength << " def\n";
843 840
    os << "/arrw " << _arrowWidth << " def\n";
844 841
    // l dx_norm dy_norm
845 842
    os << "/lrl { 2 index mul exch 2 index mul exch rlineto pop} bind def\n";
846 843
    //len w dx_norm dy_norm x1 y1 cr cg cb
847 844
    os << "/arr { setrgbcolor /y1 exch def /x1 exch def /dy exch def /dx "
848 845
       << "exch def\n"
849 846
       << "       /w exch def /len exch def\n"
850 847
      //<< "0.1 setlinewidth x1 y1 moveto dx len mul dy len mul rlineto stroke"
851 848
       << "       newpath x1 dy w 2 div mul add y1 dx w 2 div mul sub moveto\n"
852 849
       << "       len w sub arrl sub dx dy lrl\n"
853 850
       << "       arrw dy dx neg lrl\n"
854 851
       << "       dx arrl w add mul dy w 2 div arrw add mul sub\n"
855 852
       << "       dy arrl w add mul dx w 2 div arrw add mul add rlineto\n"
856 853
       << "       dx arrl w add mul neg dy w 2 div arrw add mul sub\n"
857 854
       << "       dy arrl w add mul neg dx w 2 div arrw add mul add rlineto\n"
858 855
       << "       arrw dy dx neg lrl\n"
859 856
       << "       len w sub arrl sub neg dx dy lrl\n"
860 857
       << "       closepath fill } bind def\n";
861 858
    os << "/cshow { 2 index 2 index moveto dup stringwidth pop\n"
862 859
       << "         neg 2 div fosi .35 mul neg rmoveto show pop pop} def\n";
863 860

	
864 861
    os << "\ngsave\n";
865 862
    if(_scaleToA4)
866 863
      if(bb.height()>bb.width()) {
867 864
        double sc= std::min((A4HEIGHT-2*A4BORDER)/bb.height(),
868 865
                  (A4WIDTH-2*A4BORDER)/bb.width());
869 866
        os << ((A4WIDTH -2*A4BORDER)-sc*bb.width())/2 + A4BORDER << ' '
870 867
           << ((A4HEIGHT-2*A4BORDER)-sc*bb.height())/2 + A4BORDER
871 868
           << " translate\n"
872 869
           << sc << " dup scale\n"
873 870
           << -bb.left() << ' ' << -bb.bottom() << " translate\n";
874 871
      }
875 872
      else {
876
        //\todo Verify centering
877 873
        double sc= std::min((A4HEIGHT-2*A4BORDER)/bb.width(),
878 874
                  (A4WIDTH-2*A4BORDER)/bb.height());
879 875
        os << ((A4WIDTH -2*A4BORDER)-sc*bb.height())/2 + A4BORDER << ' '
880 876
           << ((A4HEIGHT-2*A4BORDER)-sc*bb.width())/2 + A4BORDER
881 877
           << " translate\n"
882 878
           << sc << " dup scale\n90 rotate\n"
883 879
           << -bb.left() << ' ' << -bb.top() << " translate\n";
884 880
        }
885 881
    else if(_scale!=1.0) os << _scale << " dup scale\n";
886 882

	
887 883
    if(_showArcs) {
888 884
      os << "%Arcs:\ngsave\n";
889 885
      if(_enableParallel) {
890 886
        std::vector<Arc> el;
891 887
        for(ArcIt e(g);e!=INVALID;++e)
892 888
          if((!_undirected||g.source(e)<g.target(e))&&_arcWidths[e]>0
893 889
             &&g.source(e)!=g.target(e))
894 890
            el.push_back(e);
895 891
        std::sort(el.begin(),el.end(),arcLess(g));
896 892

	
897 893
        typename std::vector<Arc>::iterator j;
898 894
        for(typename std::vector<Arc>::iterator i=el.begin();i!=el.end();i=j) {
899 895
          for(j=i+1;j!=el.end()&&isParallel(*i,*j);++j) ;
900 896

	
901 897
          double sw=0;
902 898
          for(typename std::vector<Arc>::iterator e=i;e!=j;++e)
903 899
            sw+=_arcWidths[*e]*_arcWidthScale+_parArcDist;
904 900
          sw-=_parArcDist;
905 901
          sw/=-2.0;
906 902
          dim2::Point<double>
907 903
            dvec(mycoords[g.target(*i)]-mycoords[g.source(*i)]);
908 904
          double l=std::sqrt(dvec.normSquare());
909
          //\todo better 'epsilon' would be nice here.
910 905
          dim2::Point<double> d(dvec/std::max(l,EPSILON));
911 906
          dim2::Point<double> m;
912 907
//           m=dim2::Point<double>(mycoords[g.target(*i)]+
913 908
//                                 mycoords[g.source(*i)])/2.0;
914 909

	
915 910
//            m=dim2::Point<double>(mycoords[g.source(*i)])+
916 911
//             dvec*(double(_nodeSizes[g.source(*i)])/
917 912
//                (_nodeSizes[g.source(*i)]+_nodeSizes[g.target(*i)]));
918 913

	
919 914
          m=dim2::Point<double>(mycoords[g.source(*i)])+
920 915
            d*(l+_nodeSizes[g.source(*i)]-_nodeSizes[g.target(*i)])/2.0;
921 916

	
922 917
          for(typename std::vector<Arc>::iterator e=i;e!=j;++e) {
923 918
            sw+=_arcWidths[*e]*_arcWidthScale/2.0;
924 919
            dim2::Point<double> mm=m+rot90(d)*sw/.75;
925 920
            if(_drawArrows) {
926 921
              int node_shape;
927 922
              dim2::Point<double> s=mycoords[g.source(*e)];
928 923
              dim2::Point<double> t=mycoords[g.target(*e)];
929 924
              double rn=_nodeSizes[g.target(*e)]*_nodeScale;
930 925
              node_shape=_nodeShapes[g.target(*e)];
931 926
              dim2::Bezier3 bez(s,mm,mm,t);
932 927
              double t1=0,t2=1;
933 928
              for(int ii=0;ii<INTERPOL_PREC;++ii)
934 929
                if(isInsideNode(bez((t1+t2)/2)-t,rn,node_shape)) t2=(t1+t2)/2;
935 930
                else t1=(t1+t2)/2;
936 931
              dim2::Point<double> apoint=bez((t1+t2)/2);
937 932
              rn = _arrowLength+_arcWidths[*e]*_arcWidthScale;
938 933
              rn*=rn;
939 934
              t2=(t1+t2)/2;t1=0;
940 935
              for(int ii=0;ii<INTERPOL_PREC;++ii)
941 936
                if((bez((t1+t2)/2)-apoint).normSquare()>rn) t1=(t1+t2)/2;
942 937
                else t2=(t1+t2)/2;
943 938
              dim2::Point<double> linend=bez((t1+t2)/2);
944 939
              bez=bez.before((t1+t2)/2);
945 940
//               rn=_nodeSizes[g.source(*e)]*_nodeScale;
946 941
//               node_shape=_nodeShapes[g.source(*e)];
947 942
//               t1=0;t2=1;
948 943
//               for(int i=0;i<INTERPOL_PREC;++i)
949 944
//                 if(isInsideNode(bez((t1+t2)/2)-t,rn,node_shape))
950 945
//                   t1=(t1+t2)/2;
951 946
//                 else t2=(t1+t2)/2;
952 947
//               bez=bez.after((t1+t2)/2);
953 948
              os << _arcWidths[*e]*_arcWidthScale << " setlinewidth "
954 949
                 << _arcColors[*e].red() << ' '
955 950
                 << _arcColors[*e].green() << ' '
956 951
                 << _arcColors[*e].blue() << " setrgbcolor newpath\n"
957 952
                 << bez.p1.x << ' ' <<  bez.p1.y << " moveto\n"
958 953
                 << bez.p2.x << ' ' << bez.p2.y << ' '
959 954
                 << bez.p3.x << ' ' << bez.p3.y << ' '
960 955
                 << bez.p4.x << ' ' << bez.p4.y << " curveto stroke\n";
961 956
              dim2::Point<double> dd(rot90(linend-apoint));
962 957
              dd*=(.5*_arcWidths[*e]*_arcWidthScale+_arrowWidth)/
963 958
                std::sqrt(dd.normSquare());
964 959
              os << "newpath " << psOut(apoint) << " moveto "
965 960
                 << psOut(linend+dd) << " lineto "
966 961
                 << psOut(linend-dd) << " lineto closepath fill\n";
967 962
            }
968 963
            else {
969 964
              os << mycoords[g.source(*e)].x << ' '
970 965
                 << mycoords[g.source(*e)].y << ' '
971 966
                 << mm.x << ' ' << mm.y << ' '
972 967
                 << mycoords[g.target(*e)].x << ' '
973 968
                 << mycoords[g.target(*e)].y << ' '
974 969
                 << _arcColors[*e].red() << ' '
975 970
                 << _arcColors[*e].green() << ' '
976 971
                 << _arcColors[*e].blue() << ' '
977 972
                 << _arcWidths[*e]*_arcWidthScale << " lb\n";
978 973
            }
979 974
            sw+=_arcWidths[*e]*_arcWidthScale/2.0+_parArcDist;
980 975
          }
981 976
        }
982 977
      }
983 978
      else for(ArcIt e(g);e!=INVALID;++e)
984 979
        if((!_undirected||g.source(e)<g.target(e))&&_arcWidths[e]>0
985 980
           &&g.source(e)!=g.target(e)) {
986 981
          if(_drawArrows) {
987 982
            dim2::Point<double> d(mycoords[g.target(e)]-mycoords[g.source(e)]);
988 983
            double rn=_nodeSizes[g.target(e)]*_nodeScale;
989 984
            int node_shape=_nodeShapes[g.target(e)];
990 985
            double t1=0,t2=1;
991 986
            for(int i=0;i<INTERPOL_PREC;++i)
992 987
              if(isInsideNode((-(t1+t2)/2)*d,rn,node_shape)) t1=(t1+t2)/2;
993 988
              else t2=(t1+t2)/2;
994 989
            double l=std::sqrt(d.normSquare());
995 990
            d/=l;
996 991

	
997 992
            os << l*(1-(t1+t2)/2) << ' '
998 993
               << _arcWidths[e]*_arcWidthScale << ' '
999 994
               << d.x << ' ' << d.y << ' '
1000 995
               << mycoords[g.source(e)].x << ' '
1001 996
               << mycoords[g.source(e)].y << ' '
1002 997
               << _arcColors[e].red() << ' '
1003 998
               << _arcColors[e].green() << ' '
1004 999
               << _arcColors[e].blue() << " arr\n";
1005 1000
          }
1006 1001
          else os << mycoords[g.source(e)].x << ' '
1007 1002
                  << mycoords[g.source(e)].y << ' '
1008 1003
                  << mycoords[g.target(e)].x << ' '
1009 1004
                  << mycoords[g.target(e)].y << ' '
1010 1005
                  << _arcColors[e].red() << ' '
1011 1006
                  << _arcColors[e].green() << ' '
1012 1007
                  << _arcColors[e].blue() << ' '
1013 1008
                  << _arcWidths[e]*_arcWidthScale << " l\n";
1014 1009
        }
1015 1010
      os << "grestore\n";
1016 1011
    }
1017 1012
    if(_showNodes) {
1018 1013
      os << "%Nodes:\ngsave\n";
1019 1014
      for(NodeIt n(g);n!=INVALID;++n) {
1020 1015
        os << mycoords[n].x << ' ' << mycoords[n].y << ' '
1021 1016
           << _nodeSizes[n]*_nodeScale << ' '
1022 1017
           << _nodeColors[n].red() << ' '
1023 1018
           << _nodeColors[n].green() << ' '
1024 1019
           << _nodeColors[n].blue() << ' ';
1025 1020
        switch(_nodeShapes[n]) {
1026 1021
        case CIRCLE:
1027 1022
          os<< "nc";break;
1028 1023
        case SQUARE:
1029 1024
          os<< "nsq";break;
1030 1025
        case DIAMOND:
1031 1026
          os<< "ndi";break;
1032 1027
        case MALE:
1033 1028
          os<< "nmale";break;
1034 1029
        case FEMALE:
1035 1030
          os<< "nfemale";break;
1036 1031
        }
1037 1032
        os<<'\n';
1038 1033
      }
1039 1034
      os << "grestore\n";
1040 1035
    }
1041 1036
    if(_showNodeText) {
1042 1037
      os << "%Node texts:\ngsave\n";
1043 1038
      os << "/fosi " << _nodeTextSize << " def\n";
1044 1039
      os << "(Helvetica) findfont fosi scalefont setfont\n";
1045 1040
      for(NodeIt n(g);n!=INVALID;++n) {
1046 1041
        switch(_nodeTextColorType) {
1047 1042
        case DIST_COL:
1048 1043
          os << psOut(distantColor(_nodeColors[n])) << " setrgbcolor\n";
1049 1044
          break;
1050 1045
        case DIST_BW:
1051 1046
          os << psOut(distantBW(_nodeColors[n])) << " setrgbcolor\n";
1052 1047
          break;
1053 1048
        case CUST_COL:
1054 1049
          os << psOut(distantColor(_nodeTextColors[n])) << " setrgbcolor\n";
1055 1050
          break;
1056 1051
        default:
1057 1052
          os << "0 0 0 setrgbcolor\n";
1058 1053
        }
1059 1054
        os << mycoords[n].x << ' ' << mycoords[n].y
1060 1055
           << " (" << _nodeTexts[n] << ") cshow\n";
1061 1056
      }
1062 1057
      os << "grestore\n";
1063 1058
    }
1064 1059
    if(_showNodePsText) {
1065 1060
      os << "%Node PS blocks:\ngsave\n";
1066 1061
      for(NodeIt n(g);n!=INVALID;++n)
1067 1062
        os << mycoords[n].x << ' ' << mycoords[n].y
1068 1063
           << " moveto\n" << _nodePsTexts[n] << "\n";
1069 1064
      os << "grestore\n";
1070 1065
    }
1071 1066

	
1072 1067
    os << "grestore\nshowpage\n";
1073 1068

	
1074 1069
    //CleanUp:
1075 1070
    if(_pleaseRemoveOsStream) {delete &os;}
1076 1071
  }
1077 1072

	
1078 1073
  ///\name Aliases
1079 1074
  ///These are just some aliases to other parameter setting functions.
1080 1075

	
1081 1076
  ///@{
1082 1077

	
1083 1078
  ///An alias for arcWidths()
1084 1079
  template<class X> GraphToEps<ArcWidthsTraits<X> > edgeWidths(const X &x)
1085 1080
  {
1086 1081
    return arcWidths(x);
1087 1082
  }
1088 1083

	
1089 1084
  ///An alias for arcColors()
1090 1085
  template<class X> GraphToEps<ArcColorsTraits<X> >
1091 1086
  edgeColors(const X &x)
1092 1087
  {
1093 1088
    return arcColors(x);
1094 1089
  }
1095 1090

	
1096 1091
  ///An alias for arcWidthScale()
1097 1092
  GraphToEps<T> &edgeWidthScale(double d) {return arcWidthScale(d);}
1098 1093

	
1099 1094
  ///An alias for autoArcWidthScale()
1100 1095
  GraphToEps<T> &autoEdgeWidthScale(bool b=true)
1101 1096
  {
1102 1097
    return autoArcWidthScale(b);
1103 1098
  }
1104 1099

	
1105 1100
  ///An alias for absoluteArcWidths()
1106 1101
  GraphToEps<T> &absoluteEdgeWidths(bool b=true)
1107 1102
  {
1108 1103
    return absoluteArcWidths(b);
1109 1104
  }
1110 1105

	
1111 1106
  ///An alias for parArcDist()
1112 1107
  GraphToEps<T> &parEdgeDist(double d) {return parArcDist(d);}
1113 1108

	
1114 1109
  ///An alias for hideArcs()
1115 1110
  GraphToEps<T> &hideEdges(bool b=true) {return hideArcs(b);}
1116 1111

	
1117 1112
  ///@}
1118 1113
};
1119 1114

	
1120 1115
template<class T>
1121 1116
const int GraphToEps<T>::INTERPOL_PREC = 20;
1122 1117
template<class T>
1123 1118
const double GraphToEps<T>::A4HEIGHT = 841.8897637795276;
1124 1119
template<class T>
1125 1120
const double GraphToEps<T>::A4WIDTH  = 595.275590551181;
1126 1121
template<class T>
1127 1122
const double GraphToEps<T>::A4BORDER = 15;
1128 1123

	
1129 1124

	
1130 1125
///Generates an EPS file from a graph
1131 1126

	
1132 1127
///\ingroup eps_io
1133 1128
///Generates an EPS file from a graph.
1134 1129
///\param g Reference to the graph to be printed.
1135 1130
///\param os Reference to the output stream.
1136 1131
///By default it is <tt>std::cout</tt>.
1137 1132
///
1138 1133
///This function also has a lot of
1139 1134
///\ref named-templ-func-param "named parameters",
1140 1135
///they are declared as the members of class \ref GraphToEps. The following
1141 1136
///example shows how to use these parameters.
1142 1137
///\code
1143 1138
/// graphToEps(g,os).scale(10).coords(coords)
1144 1139
///              .nodeScale(2).nodeSizes(sizes)
1145 1140
///              .arcWidthScale(.4).run();
1146 1141
///\endcode
1147 1142
///
1148 1143
///For more detailed examples see the \ref graph_to_eps_demo.cc demo file.
1149 1144
///
1150 1145
///\warning Don't forget to put the \ref GraphToEps::run() "run()"
1151 1146
///to the end of the parameter list.
1152 1147
///\sa GraphToEps
1153 1148
///\sa graphToEps(G &g, const char *file_name)
1154 1149
template<class G>
1155 1150
GraphToEps<DefaultGraphToEpsTraits<G> >
1156 1151
graphToEps(G &g, std::ostream& os=std::cout)
1157 1152
{
1158 1153
  return
1159 1154
    GraphToEps<DefaultGraphToEpsTraits<G> >(DefaultGraphToEpsTraits<G>(g,os));
1160 1155
}
1161 1156

	
1162 1157
///Generates an EPS file from a graph
1163 1158

	
1164 1159
///\ingroup eps_io
1165 1160
///This function does the same as
1166 1161
///\ref graphToEps(G &g,std::ostream& os)
1167 1162
///but it writes its output into the file \c file_name
1168 1163
///instead of a stream.
1169 1164
///\sa graphToEps(G &g, std::ostream& os)
1170 1165
template<class G>
1171 1166
GraphToEps<DefaultGraphToEpsTraits<G> >
1172 1167
graphToEps(G &g,const char *file_name)
1173 1168
{
1174 1169
  return GraphToEps<DefaultGraphToEpsTraits<G> >
1175 1170
    (DefaultGraphToEpsTraits<G>(g,*new std::ofstream(file_name),true));
1176 1171
}
1177 1172

	
1178 1173
///Generates an EPS file from a graph
1179 1174

	
1180 1175
///\ingroup eps_io
1181 1176
///This function does the same as
1182 1177
///\ref graphToEps(G &g,std::ostream& os)
1183 1178
///but it writes its output into the file \c file_name
1184 1179
///instead of a stream.
1185 1180
///\sa graphToEps(G &g, std::ostream& os)
1186 1181
template<class G>
1187 1182
GraphToEps<DefaultGraphToEpsTraits<G> >
1188 1183
graphToEps(G &g,const std::string& file_name)
1189 1184
{
1190 1185
  return GraphToEps<DefaultGraphToEpsTraits<G> >
1191 1186
    (DefaultGraphToEpsTraits<G>(g,*new std::ofstream(file_name.c_str()),true));
1192 1187
}
1193 1188

	
1194 1189
} //END OF NAMESPACE LEMON
1195 1190

	
1196 1191
#endif // LEMON_GRAPH_TO_EPS_H

Changeset was too big and was cut off... Show full diff

0 comments (0 inline)