lemon/bellman_ford.h
author Alpar Juttner <alpar@cs.elte.hu>
Mon, 31 Aug 2009 10:03:23 +0200
changeset 708 5d313b76f323
parent 697 9496ed797f20
child 781 6f10c6ec5a21
child 786 e20173729589
permissions -rw-r--r--
Merge
kpeter@696
     1
/* -*- C++ -*-
kpeter@696
     2
 *
kpeter@696
     3
 * This file is a part of LEMON, a generic C++ optimization library
kpeter@696
     4
 *
kpeter@696
     5
 * Copyright (C) 2003-2008
kpeter@696
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@696
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@696
     8
 *
kpeter@696
     9
 * Permission to use, modify and distribute this software is granted
kpeter@696
    10
 * provided that this copyright notice appears in all copies. For
kpeter@696
    11
 * precise terms see the accompanying LICENSE file.
kpeter@696
    12
 *
kpeter@696
    13
 * This software is provided "AS IS" with no warranty of any kind,
kpeter@696
    14
 * express or implied, and with no claim as to its suitability for any
kpeter@696
    15
 * purpose.
kpeter@696
    16
 *
kpeter@696
    17
 */
kpeter@696
    18
kpeter@697
    19
#ifndef LEMON_BELLMAN_FORD_H
kpeter@697
    20
#define LEMON_BELLMAN_FORD_H
kpeter@696
    21
kpeter@696
    22
/// \ingroup shortest_path
kpeter@696
    23
/// \file
kpeter@696
    24
/// \brief Bellman-Ford algorithm.
kpeter@696
    25
kpeter@696
    26
#include <lemon/bits/path_dump.h>
kpeter@696
    27
#include <lemon/core.h>
kpeter@696
    28
#include <lemon/error.h>
kpeter@696
    29
#include <lemon/maps.h>
kpeter@697
    30
#include <lemon/path.h>
kpeter@696
    31
kpeter@696
    32
#include <limits>
kpeter@696
    33
kpeter@696
    34
namespace lemon {
kpeter@696
    35
kpeter@696
    36
  /// \brief Default OperationTraits for the BellmanFord algorithm class.
kpeter@696
    37
  ///  
kpeter@697
    38
  /// This operation traits class defines all computational operations
kpeter@697
    39
  /// and constants that are used in the Bellman-Ford algorithm.
kpeter@697
    40
  /// The default implementation is based on the \c numeric_limits class.
kpeter@697
    41
  /// If the numeric type does not have infinity value, then the maximum
kpeter@697
    42
  /// value is used as extremal infinity value.
kpeter@696
    43
  template <
kpeter@697
    44
    typename V, 
kpeter@697
    45
    bool has_inf = std::numeric_limits<V>::has_infinity>
kpeter@696
    46
  struct BellmanFordDefaultOperationTraits {
kpeter@697
    47
    /// \e
kpeter@697
    48
    typedef V Value;
kpeter@696
    49
    /// \brief Gives back the zero value of the type.
kpeter@696
    50
    static Value zero() {
kpeter@696
    51
      return static_cast<Value>(0);
kpeter@696
    52
    }
kpeter@696
    53
    /// \brief Gives back the positive infinity value of the type.
kpeter@696
    54
    static Value infinity() {
kpeter@696
    55
      return std::numeric_limits<Value>::infinity();
kpeter@696
    56
    }
kpeter@696
    57
    /// \brief Gives back the sum of the given two elements.
kpeter@696
    58
    static Value plus(const Value& left, const Value& right) {
kpeter@696
    59
      return left + right;
kpeter@696
    60
    }
kpeter@697
    61
    /// \brief Gives back \c true only if the first value is less than
kpeter@697
    62
    /// the second.
kpeter@696
    63
    static bool less(const Value& left, const Value& right) {
kpeter@696
    64
      return left < right;
kpeter@696
    65
    }
kpeter@696
    66
  };
kpeter@696
    67
kpeter@697
    68
  template <typename V>
kpeter@697
    69
  struct BellmanFordDefaultOperationTraits<V, false> {
kpeter@697
    70
    typedef V Value;
kpeter@696
    71
    static Value zero() {
kpeter@696
    72
      return static_cast<Value>(0);
kpeter@696
    73
    }
kpeter@696
    74
    static Value infinity() {
kpeter@696
    75
      return std::numeric_limits<Value>::max();
kpeter@696
    76
    }
kpeter@696
    77
    static Value plus(const Value& left, const Value& right) {
kpeter@696
    78
      if (left == infinity() || right == infinity()) return infinity();
kpeter@696
    79
      return left + right;
kpeter@696
    80
    }
kpeter@696
    81
    static bool less(const Value& left, const Value& right) {
kpeter@696
    82
      return left < right;
kpeter@696
    83
    }
kpeter@696
    84
  };
kpeter@696
    85
  
kpeter@696
    86
  /// \brief Default traits class of BellmanFord class.
kpeter@696
    87
  ///
kpeter@696
    88
  /// Default traits class of BellmanFord class.
kpeter@697
    89
  /// \param GR The type of the digraph.
kpeter@697
    90
  /// \param LEN The type of the length map.
kpeter@697
    91
  template<typename GR, typename LEN>
kpeter@696
    92
  struct BellmanFordDefaultTraits {
kpeter@697
    93
    /// The type of the digraph the algorithm runs on. 
kpeter@697
    94
    typedef GR Digraph;
kpeter@696
    95
kpeter@696
    96
    /// \brief The type of the map that stores the arc lengths.
kpeter@696
    97
    ///
kpeter@696
    98
    /// The type of the map that stores the arc lengths.
kpeter@697
    99
    /// It must conform to the \ref concepts::ReadMap "ReadMap" concept.
kpeter@697
   100
    typedef LEN LengthMap;
kpeter@696
   101
kpeter@697
   102
    /// The type of the arc lengths.
kpeter@697
   103
    typedef typename LEN::Value Value;
kpeter@696
   104
kpeter@696
   105
    /// \brief Operation traits for Bellman-Ford algorithm.
kpeter@696
   106
    ///
kpeter@697
   107
    /// It defines the used operations and the infinity value for the
kpeter@697
   108
    /// given \c Value type.
kpeter@696
   109
    /// \see BellmanFordDefaultOperationTraits
kpeter@696
   110
    typedef BellmanFordDefaultOperationTraits<Value> OperationTraits;
kpeter@696
   111
 
kpeter@696
   112
    /// \brief The type of the map that stores the last arcs of the 
kpeter@696
   113
    /// shortest paths.
kpeter@696
   114
    /// 
kpeter@696
   115
    /// The type of the map that stores the last
kpeter@696
   116
    /// arcs of the shortest paths.
kpeter@697
   117
    /// It must conform to the \ref concepts::WriteMap "WriteMap" concept.
kpeter@697
   118
    typedef typename GR::template NodeMap<typename GR::Arc> PredMap;
kpeter@696
   119
kpeter@697
   120
    /// \brief Instantiates a \c PredMap.
kpeter@696
   121
    /// 
kpeter@696
   122
    /// This function instantiates a \ref PredMap. 
kpeter@697
   123
    /// \param g is the digraph to which we would like to define the
kpeter@697
   124
    /// \ref PredMap.
kpeter@697
   125
    static PredMap *createPredMap(const GR& g) {
kpeter@697
   126
      return new PredMap(g);
kpeter@696
   127
    }
kpeter@696
   128
kpeter@697
   129
    /// \brief The type of the map that stores the distances of the nodes.
kpeter@696
   130
    ///
kpeter@697
   131
    /// The type of the map that stores the distances of the nodes.
kpeter@697
   132
    /// It must conform to the \ref concepts::WriteMap "WriteMap" concept.
kpeter@697
   133
    typedef typename GR::template NodeMap<typename LEN::Value> DistMap;
kpeter@696
   134
kpeter@697
   135
    /// \brief Instantiates a \c DistMap.
kpeter@696
   136
    ///
kpeter@696
   137
    /// This function instantiates a \ref DistMap. 
kpeter@697
   138
    /// \param g is the digraph to which we would like to define the 
kpeter@697
   139
    /// \ref DistMap.
kpeter@697
   140
    static DistMap *createDistMap(const GR& g) {
kpeter@697
   141
      return new DistMap(g);
kpeter@696
   142
    }
kpeter@696
   143
kpeter@696
   144
  };
kpeter@696
   145
  
kpeter@696
   146
  /// \brief %BellmanFord algorithm class.
kpeter@696
   147
  ///
kpeter@696
   148
  /// \ingroup shortest_path
kpeter@697
   149
  /// This class provides an efficient implementation of the Bellman-Ford 
kpeter@697
   150
  /// algorithm. The maximum time complexity of the algorithm is
kpeter@697
   151
  /// <tt>O(ne)</tt>.
kpeter@697
   152
  ///
kpeter@697
   153
  /// The Bellman-Ford algorithm solves the single-source shortest path
kpeter@697
   154
  /// problem when the arcs can have negative lengths, but the digraph
kpeter@697
   155
  /// should not contain directed cycles with negative total length.
kpeter@697
   156
  /// If all arc costs are non-negative, consider to use the Dijkstra
kpeter@697
   157
  /// algorithm instead, since it is more efficient.
kpeter@697
   158
  ///
kpeter@697
   159
  /// The arc lengths are passed to the algorithm using a
kpeter@696
   160
  /// \ref concepts::ReadMap "ReadMap", so it is easy to change it to any 
kpeter@697
   161
  /// kind of length. The type of the length values is determined by the
kpeter@697
   162
  /// \ref concepts::ReadMap::Value "Value" type of the length map.
kpeter@696
   163
  ///
kpeter@697
   164
  /// There is also a \ref bellmanFord() "function-type interface" for the
kpeter@697
   165
  /// Bellman-Ford algorithm, which is convenient in the simplier cases and
kpeter@697
   166
  /// it can be used easier.
kpeter@696
   167
  ///
kpeter@697
   168
  /// \tparam GR The type of the digraph the algorithm runs on.
kpeter@697
   169
  /// The default type is \ref ListDigraph.
kpeter@697
   170
  /// \tparam LEN A \ref concepts::ReadMap "readable" arc map that specifies
kpeter@697
   171
  /// the lengths of the arcs. The default map type is
kpeter@697
   172
  /// \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
kpeter@696
   173
#ifdef DOXYGEN
kpeter@697
   174
  template <typename GR, typename LEN, typename TR>
kpeter@696
   175
#else
kpeter@697
   176
  template <typename GR=ListDigraph,
kpeter@697
   177
            typename LEN=typename GR::template ArcMap<int>,
kpeter@697
   178
            typename TR=BellmanFordDefaultTraits<GR,LEN> >
kpeter@696
   179
#endif
kpeter@696
   180
  class BellmanFord {
kpeter@696
   181
  public:
kpeter@696
   182
kpeter@696
   183
    ///The type of the underlying digraph.
kpeter@697
   184
    typedef typename TR::Digraph Digraph;
kpeter@697
   185
    
kpeter@697
   186
    /// \brief The type of the arc lengths.
kpeter@697
   187
    typedef typename TR::LengthMap::Value Value;
kpeter@697
   188
    /// \brief The type of the map that stores the arc lengths.
kpeter@697
   189
    typedef typename TR::LengthMap LengthMap;
kpeter@697
   190
    /// \brief The type of the map that stores the last
kpeter@697
   191
    /// arcs of the shortest paths.
kpeter@697
   192
    typedef typename TR::PredMap PredMap;
kpeter@697
   193
    /// \brief The type of the map that stores the distances of the nodes.
kpeter@697
   194
    typedef typename TR::DistMap DistMap;
kpeter@697
   195
    /// The type of the paths.
kpeter@697
   196
    typedef PredMapPath<Digraph, PredMap> Path;
kpeter@697
   197
    ///\brief The \ref BellmanFordDefaultOperationTraits
kpeter@697
   198
    /// "operation traits class" of the algorithm.
kpeter@697
   199
    typedef typename TR::OperationTraits OperationTraits;
kpeter@697
   200
kpeter@697
   201
    ///The \ref BellmanFordDefaultTraits "traits class" of the algorithm.
kpeter@697
   202
    typedef TR Traits;
kpeter@697
   203
kpeter@697
   204
  private:
kpeter@696
   205
kpeter@696
   206
    typedef typename Digraph::Node Node;
kpeter@696
   207
    typedef typename Digraph::NodeIt NodeIt;
kpeter@696
   208
    typedef typename Digraph::Arc Arc;
kpeter@696
   209
    typedef typename Digraph::OutArcIt OutArcIt;
kpeter@697
   210
kpeter@697
   211
    // Pointer to the underlying digraph.
kpeter@697
   212
    const Digraph *_gr;
kpeter@697
   213
    // Pointer to the length map
kpeter@697
   214
    const LengthMap *_length;
kpeter@697
   215
    // Pointer to the map of predecessors arcs.
kpeter@696
   216
    PredMap *_pred;
kpeter@697
   217
    // Indicates if _pred is locally allocated (true) or not.
kpeter@697
   218
    bool _local_pred;
kpeter@697
   219
    // Pointer to the map of distances.
kpeter@696
   220
    DistMap *_dist;
kpeter@697
   221
    // Indicates if _dist is locally allocated (true) or not.
kpeter@697
   222
    bool _local_dist;
kpeter@696
   223
kpeter@696
   224
    typedef typename Digraph::template NodeMap<bool> MaskMap;
kpeter@696
   225
    MaskMap *_mask;
kpeter@696
   226
kpeter@696
   227
    std::vector<Node> _process;
kpeter@696
   228
kpeter@697
   229
    // Creates the maps if necessary.
kpeter@696
   230
    void create_maps() {
kpeter@696
   231
      if(!_pred) {
kpeter@697
   232
	_local_pred = true;
kpeter@697
   233
	_pred = Traits::createPredMap(*_gr);
kpeter@696
   234
      }
kpeter@696
   235
      if(!_dist) {
kpeter@697
   236
	_local_dist = true;
kpeter@697
   237
	_dist = Traits::createDistMap(*_gr);
kpeter@696
   238
      }
kpeter@697
   239
      _mask = new MaskMap(*_gr, false);
kpeter@696
   240
    }
kpeter@696
   241
    
kpeter@696
   242
  public :
kpeter@696
   243
 
kpeter@696
   244
    typedef BellmanFord Create;
kpeter@696
   245
kpeter@697
   246
    /// \name Named Template Parameters
kpeter@696
   247
kpeter@696
   248
    ///@{
kpeter@696
   249
kpeter@696
   250
    template <class T>
kpeter@697
   251
    struct SetPredMapTraits : public Traits {
kpeter@696
   252
      typedef T PredMap;
kpeter@696
   253
      static PredMap *createPredMap(const Digraph&) {
kpeter@696
   254
        LEMON_ASSERT(false, "PredMap is not initialized");
kpeter@696
   255
        return 0; // ignore warnings
kpeter@696
   256
      }
kpeter@696
   257
    };
kpeter@696
   258
kpeter@697
   259
    /// \brief \ref named-templ-param "Named parameter" for setting
kpeter@697
   260
    /// \c PredMap type.
kpeter@696
   261
    ///
kpeter@697
   262
    /// \ref named-templ-param "Named parameter" for setting
kpeter@697
   263
    /// \c PredMap type.
kpeter@697
   264
    /// It must conform to the \ref concepts::WriteMap "WriteMap" concept.
kpeter@696
   265
    template <class T>
kpeter@696
   266
    struct SetPredMap 
kpeter@697
   267
      : public BellmanFord< Digraph, LengthMap, SetPredMapTraits<T> > {
kpeter@697
   268
      typedef BellmanFord< Digraph, LengthMap, SetPredMapTraits<T> > Create;
kpeter@696
   269
    };
kpeter@696
   270
    
kpeter@696
   271
    template <class T>
kpeter@697
   272
    struct SetDistMapTraits : public Traits {
kpeter@696
   273
      typedef T DistMap;
kpeter@696
   274
      static DistMap *createDistMap(const Digraph&) {
kpeter@696
   275
        LEMON_ASSERT(false, "DistMap is not initialized");
kpeter@696
   276
        return 0; // ignore warnings
kpeter@696
   277
      }
kpeter@696
   278
    };
kpeter@696
   279
kpeter@697
   280
    /// \brief \ref named-templ-param "Named parameter" for setting
kpeter@697
   281
    /// \c DistMap type.
kpeter@696
   282
    ///
kpeter@697
   283
    /// \ref named-templ-param "Named parameter" for setting
kpeter@697
   284
    /// \c DistMap type.
kpeter@697
   285
    /// It must conform to the \ref concepts::WriteMap "WriteMap" concept.
kpeter@696
   286
    template <class T>
kpeter@696
   287
    struct SetDistMap 
kpeter@697
   288
      : public BellmanFord< Digraph, LengthMap, SetDistMapTraits<T> > {
kpeter@697
   289
      typedef BellmanFord< Digraph, LengthMap, SetDistMapTraits<T> > Create;
kpeter@696
   290
    };
kpeter@697
   291
kpeter@696
   292
    template <class T>
kpeter@697
   293
    struct SetOperationTraitsTraits : public Traits {
kpeter@696
   294
      typedef T OperationTraits;
kpeter@696
   295
    };
kpeter@696
   296
    
kpeter@696
   297
    /// \brief \ref named-templ-param "Named parameter" for setting 
kpeter@697
   298
    /// \c OperationTraits type.
kpeter@696
   299
    ///
kpeter@697
   300
    /// \ref named-templ-param "Named parameter" for setting
kpeter@697
   301
    /// \c OperationTraits type.
kpeter@697
   302
    /// For more information see \ref BellmanFordDefaultOperationTraits.
kpeter@696
   303
    template <class T>
kpeter@696
   304
    struct SetOperationTraits
kpeter@697
   305
      : public BellmanFord< Digraph, LengthMap, SetOperationTraitsTraits<T> > {
kpeter@697
   306
      typedef BellmanFord< Digraph, LengthMap, SetOperationTraitsTraits<T> >
kpeter@696
   307
      Create;
kpeter@696
   308
    };
kpeter@696
   309
    
kpeter@696
   310
    ///@}
kpeter@696
   311
kpeter@696
   312
  protected:
kpeter@696
   313
    
kpeter@696
   314
    BellmanFord() {}
kpeter@696
   315
kpeter@696
   316
  public:      
kpeter@696
   317
    
kpeter@696
   318
    /// \brief Constructor.
kpeter@696
   319
    ///
kpeter@697
   320
    /// Constructor.
kpeter@697
   321
    /// \param g The digraph the algorithm runs on.
kpeter@697
   322
    /// \param length The length map used by the algorithm.
kpeter@697
   323
    BellmanFord(const Digraph& g, const LengthMap& length) :
kpeter@697
   324
      _gr(&g), _length(&length),
kpeter@697
   325
      _pred(0), _local_pred(false),
kpeter@697
   326
      _dist(0), _local_dist(false), _mask(0) {}
kpeter@696
   327
    
kpeter@696
   328
    ///Destructor.
kpeter@696
   329
    ~BellmanFord() {
kpeter@697
   330
      if(_local_pred) delete _pred;
kpeter@697
   331
      if(_local_dist) delete _dist;
kpeter@696
   332
      if(_mask) delete _mask;
kpeter@696
   333
    }
kpeter@696
   334
kpeter@696
   335
    /// \brief Sets the length map.
kpeter@696
   336
    ///
kpeter@696
   337
    /// Sets the length map.
kpeter@697
   338
    /// \return <tt>(*this)</tt>
kpeter@697
   339
    BellmanFord &lengthMap(const LengthMap &map) {
kpeter@697
   340
      _length = &map;
kpeter@696
   341
      return *this;
kpeter@696
   342
    }
kpeter@696
   343
kpeter@697
   344
    /// \brief Sets the map that stores the predecessor arcs.
kpeter@696
   345
    ///
kpeter@697
   346
    /// Sets the map that stores the predecessor arcs.
kpeter@697
   347
    /// If you don't use this function before calling \ref run()
kpeter@697
   348
    /// or \ref init(), an instance will be allocated automatically.
kpeter@697
   349
    /// The destructor deallocates this automatically allocated map,
kpeter@697
   350
    /// of course.
kpeter@697
   351
    /// \return <tt>(*this)</tt>
kpeter@697
   352
    BellmanFord &predMap(PredMap &map) {
kpeter@697
   353
      if(_local_pred) {
kpeter@696
   354
	delete _pred;
kpeter@697
   355
	_local_pred=false;
kpeter@696
   356
      }
kpeter@697
   357
      _pred = &map;
kpeter@696
   358
      return *this;
kpeter@696
   359
    }
kpeter@696
   360
kpeter@697
   361
    /// \brief Sets the map that stores the distances of the nodes.
kpeter@696
   362
    ///
kpeter@697
   363
    /// Sets the map that stores the distances of the nodes calculated
kpeter@697
   364
    /// by the algorithm.
kpeter@697
   365
    /// If you don't use this function before calling \ref run()
kpeter@697
   366
    /// or \ref init(), an instance will be allocated automatically.
kpeter@697
   367
    /// The destructor deallocates this automatically allocated map,
kpeter@697
   368
    /// of course.
kpeter@697
   369
    /// \return <tt>(*this)</tt>
kpeter@697
   370
    BellmanFord &distMap(DistMap &map) {
kpeter@697
   371
      if(_local_dist) {
kpeter@696
   372
	delete _dist;
kpeter@697
   373
	_local_dist=false;
kpeter@696
   374
      }
kpeter@697
   375
      _dist = &map;
kpeter@696
   376
      return *this;
kpeter@696
   377
    }
kpeter@696
   378
kpeter@697
   379
    /// \name Execution Control
kpeter@697
   380
    /// The simplest way to execute the Bellman-Ford algorithm is to use
kpeter@697
   381
    /// one of the member functions called \ref run().\n
kpeter@697
   382
    /// If you need better control on the execution, you have to call
kpeter@697
   383
    /// \ref init() first, then you can add several source nodes
kpeter@697
   384
    /// with \ref addSource(). Finally the actual path computation can be
kpeter@697
   385
    /// performed with \ref start(), \ref checkedStart() or
kpeter@697
   386
    /// \ref limitedStart().
kpeter@696
   387
kpeter@696
   388
    ///@{
kpeter@696
   389
kpeter@696
   390
    /// \brief Initializes the internal data structures.
kpeter@696
   391
    /// 
kpeter@697
   392
    /// Initializes the internal data structures. The optional parameter
kpeter@697
   393
    /// is the initial distance of each node.
kpeter@696
   394
    void init(const Value value = OperationTraits::infinity()) {
kpeter@696
   395
      create_maps();
kpeter@697
   396
      for (NodeIt it(*_gr); it != INVALID; ++it) {
kpeter@696
   397
	_pred->set(it, INVALID);
kpeter@696
   398
	_dist->set(it, value);
kpeter@696
   399
      }
kpeter@696
   400
      _process.clear();
kpeter@696
   401
      if (OperationTraits::less(value, OperationTraits::infinity())) {
kpeter@697
   402
	for (NodeIt it(*_gr); it != INVALID; ++it) {
kpeter@696
   403
	  _process.push_back(it);
kpeter@696
   404
	  _mask->set(it, true);
kpeter@696
   405
	}
kpeter@696
   406
      }
kpeter@696
   407
    }
kpeter@696
   408
    
kpeter@696
   409
    /// \brief Adds a new source node.
kpeter@696
   410
    ///
kpeter@697
   411
    /// This function adds a new source node. The optional second parameter
kpeter@697
   412
    /// is the initial distance of the node.
kpeter@696
   413
    void addSource(Node source, Value dst = OperationTraits::zero()) {
kpeter@696
   414
      _dist->set(source, dst);
kpeter@696
   415
      if (!(*_mask)[source]) {
kpeter@696
   416
	_process.push_back(source);
kpeter@696
   417
	_mask->set(source, true);
kpeter@696
   418
      }
kpeter@696
   419
    }
kpeter@696
   420
kpeter@696
   421
    /// \brief Executes one round from the Bellman-Ford algorithm.
kpeter@696
   422
    ///
kpeter@696
   423
    /// If the algoritm calculated the distances in the previous round
kpeter@697
   424
    /// exactly for the paths of at most \c k arcs, then this function
kpeter@697
   425
    /// will calculate the distances exactly for the paths of at most
kpeter@697
   426
    /// <tt>k+1</tt> arcs. Performing \c k iterations using this function
kpeter@697
   427
    /// calculates the shortest path distances exactly for the paths
kpeter@697
   428
    /// consisting of at most \c k arcs.
kpeter@696
   429
    ///
kpeter@696
   430
    /// \warning The paths with limited arc number cannot be retrieved
kpeter@697
   431
    /// easily with \ref path() or \ref predArc() functions. If you also
kpeter@697
   432
    /// need the shortest paths and not only the distances, you should
kpeter@697
   433
    /// store the \ref predMap() "predecessor map" after each iteration
kpeter@697
   434
    /// and build the path manually.
kpeter@696
   435
    ///
kpeter@696
   436
    /// \return \c true when the algorithm have not found more shorter
kpeter@696
   437
    /// paths.
kpeter@697
   438
    ///
kpeter@697
   439
    /// \see ActiveIt
kpeter@696
   440
    bool processNextRound() {
kpeter@696
   441
      for (int i = 0; i < int(_process.size()); ++i) {
kpeter@696
   442
	_mask->set(_process[i], false);
kpeter@696
   443
      }
kpeter@696
   444
      std::vector<Node> nextProcess;
kpeter@696
   445
      std::vector<Value> values(_process.size());
kpeter@696
   446
      for (int i = 0; i < int(_process.size()); ++i) {
kpeter@696
   447
	values[i] = (*_dist)[_process[i]];
kpeter@696
   448
      }
kpeter@696
   449
      for (int i = 0; i < int(_process.size()); ++i) {
kpeter@697
   450
	for (OutArcIt it(*_gr, _process[i]); it != INVALID; ++it) {
kpeter@697
   451
	  Node target = _gr->target(it);
kpeter@697
   452
	  Value relaxed = OperationTraits::plus(values[i], (*_length)[it]);
kpeter@696
   453
	  if (OperationTraits::less(relaxed, (*_dist)[target])) {
kpeter@696
   454
	    _pred->set(target, it);
kpeter@696
   455
	    _dist->set(target, relaxed);
kpeter@696
   456
	    if (!(*_mask)[target]) {
kpeter@696
   457
	      _mask->set(target, true);
kpeter@696
   458
	      nextProcess.push_back(target);
kpeter@696
   459
	    }
kpeter@696
   460
	  }	  
kpeter@696
   461
	}
kpeter@696
   462
      }
kpeter@696
   463
      _process.swap(nextProcess);
kpeter@696
   464
      return _process.empty();
kpeter@696
   465
    }
kpeter@696
   466
kpeter@696
   467
    /// \brief Executes one weak round from the Bellman-Ford algorithm.
kpeter@696
   468
    ///
kpeter@697
   469
    /// If the algorithm calculated the distances in the previous round
kpeter@697
   470
    /// at least for the paths of at most \c k arcs, then this function
kpeter@697
   471
    /// will calculate the distances at least for the paths of at most
kpeter@697
   472
    /// <tt>k+1</tt> arcs.
kpeter@697
   473
    /// This function does not make it possible to calculate the shortest
kpeter@697
   474
    /// path distances exactly for paths consisting of at most \c k arcs,
kpeter@697
   475
    /// this is why it is called weak round.
kpeter@697
   476
    ///
kpeter@697
   477
    /// \return \c true when the algorithm have not found more shorter
kpeter@697
   478
    /// paths.
kpeter@697
   479
    ///
kpeter@697
   480
    /// \see ActiveIt
kpeter@696
   481
    bool processNextWeakRound() {
kpeter@696
   482
      for (int i = 0; i < int(_process.size()); ++i) {
kpeter@696
   483
	_mask->set(_process[i], false);
kpeter@696
   484
      }
kpeter@696
   485
      std::vector<Node> nextProcess;
kpeter@696
   486
      for (int i = 0; i < int(_process.size()); ++i) {
kpeter@697
   487
	for (OutArcIt it(*_gr, _process[i]); it != INVALID; ++it) {
kpeter@697
   488
	  Node target = _gr->target(it);
kpeter@696
   489
	  Value relaxed = 
kpeter@697
   490
	    OperationTraits::plus((*_dist)[_process[i]], (*_length)[it]);
kpeter@696
   491
	  if (OperationTraits::less(relaxed, (*_dist)[target])) {
kpeter@696
   492
	    _pred->set(target, it);
kpeter@696
   493
	    _dist->set(target, relaxed);
kpeter@696
   494
	    if (!(*_mask)[target]) {
kpeter@696
   495
	      _mask->set(target, true);
kpeter@696
   496
	      nextProcess.push_back(target);
kpeter@696
   497
	    }
kpeter@696
   498
	  }	  
kpeter@696
   499
	}
kpeter@696
   500
      }
kpeter@696
   501
      _process.swap(nextProcess);
kpeter@696
   502
      return _process.empty();
kpeter@696
   503
    }
kpeter@696
   504
kpeter@696
   505
    /// \brief Executes the algorithm.
kpeter@696
   506
    ///
kpeter@697
   507
    /// Executes the algorithm.
kpeter@696
   508
    ///
kpeter@697
   509
    /// This method runs the Bellman-Ford algorithm from the root node(s)
kpeter@697
   510
    /// in order to compute the shortest path to each node.
kpeter@697
   511
    ///
kpeter@697
   512
    /// The algorithm computes
kpeter@697
   513
    /// - the shortest path tree (forest),
kpeter@697
   514
    /// - the distance of each node from the root(s).
kpeter@697
   515
    ///
kpeter@697
   516
    /// \pre init() must be called and at least one root node should be
kpeter@697
   517
    /// added with addSource() before using this function.
kpeter@696
   518
    void start() {
kpeter@697
   519
      int num = countNodes(*_gr) - 1;
kpeter@696
   520
      for (int i = 0; i < num; ++i) {
kpeter@696
   521
	if (processNextWeakRound()) break;
kpeter@696
   522
      }
kpeter@696
   523
    }
kpeter@696
   524
kpeter@696
   525
    /// \brief Executes the algorithm and checks the negative cycles.
kpeter@696
   526
    ///
kpeter@697
   527
    /// Executes the algorithm and checks the negative cycles.
kpeter@696
   528
    ///
kpeter@697
   529
    /// This method runs the Bellman-Ford algorithm from the root node(s)
kpeter@697
   530
    /// in order to compute the shortest path to each node and also checks
kpeter@697
   531
    /// if the digraph contains cycles with negative total length.
kpeter@697
   532
    ///
kpeter@697
   533
    /// The algorithm computes 
kpeter@697
   534
    /// - the shortest path tree (forest),
kpeter@697
   535
    /// - the distance of each node from the root(s).
kpeter@696
   536
    /// 
kpeter@696
   537
    /// \return \c false if there is a negative cycle in the digraph.
kpeter@697
   538
    ///
kpeter@697
   539
    /// \pre init() must be called and at least one root node should be
kpeter@697
   540
    /// added with addSource() before using this function. 
kpeter@696
   541
    bool checkedStart() {
kpeter@697
   542
      int num = countNodes(*_gr);
kpeter@696
   543
      for (int i = 0; i < num; ++i) {
kpeter@696
   544
	if (processNextWeakRound()) return true;
kpeter@696
   545
      }
kpeter@696
   546
      return _process.empty();
kpeter@696
   547
    }
kpeter@696
   548
kpeter@697
   549
    /// \brief Executes the algorithm with arc number limit.
kpeter@696
   550
    ///
kpeter@697
   551
    /// Executes the algorithm with arc number limit.
kpeter@696
   552
    ///
kpeter@697
   553
    /// This method runs the Bellman-Ford algorithm from the root node(s)
kpeter@697
   554
    /// in order to compute the shortest path distance for each node
kpeter@697
   555
    /// using only the paths consisting of at most \c num arcs.
kpeter@697
   556
    ///
kpeter@697
   557
    /// The algorithm computes
kpeter@697
   558
    /// - the limited distance of each node from the root(s),
kpeter@697
   559
    /// - the predecessor arc for each node.
kpeter@696
   560
    ///
kpeter@696
   561
    /// \warning The paths with limited arc number cannot be retrieved
kpeter@697
   562
    /// easily with \ref path() or \ref predArc() functions. If you also
kpeter@697
   563
    /// need the shortest paths and not only the distances, you should
kpeter@697
   564
    /// store the \ref predMap() "predecessor map" after each iteration
kpeter@697
   565
    /// and build the path manually.
kpeter@696
   566
    ///
kpeter@697
   567
    /// \pre init() must be called and at least one root node should be
kpeter@697
   568
    /// added with addSource() before using this function. 
kpeter@696
   569
    void limitedStart(int num) {
kpeter@696
   570
      for (int i = 0; i < num; ++i) {
kpeter@696
   571
	if (processNextRound()) break;
kpeter@696
   572
      }
kpeter@696
   573
    }
kpeter@696
   574
    
kpeter@697
   575
    /// \brief Runs the algorithm from the given root node.
kpeter@696
   576
    ///    
kpeter@697
   577
    /// This method runs the Bellman-Ford algorithm from the given root
kpeter@697
   578
    /// node \c s in order to compute the shortest path to each node.
kpeter@696
   579
    ///
kpeter@697
   580
    /// The algorithm computes
kpeter@697
   581
    /// - the shortest path tree (forest),
kpeter@697
   582
    /// - the distance of each node from the root(s).
kpeter@697
   583
    ///
kpeter@697
   584
    /// \note bf.run(s) is just a shortcut of the following code.
kpeter@697
   585
    /// \code
kpeter@697
   586
    ///   bf.init();
kpeter@697
   587
    ///   bf.addSource(s);
kpeter@697
   588
    ///   bf.start();
kpeter@697
   589
    /// \endcode
kpeter@696
   590
    void run(Node s) {
kpeter@696
   591
      init();
kpeter@696
   592
      addSource(s);
kpeter@696
   593
      start();
kpeter@696
   594
    }
kpeter@696
   595
    
kpeter@697
   596
    /// \brief Runs the algorithm from the given root node with arc
kpeter@697
   597
    /// number limit.
kpeter@696
   598
    ///    
kpeter@697
   599
    /// This method runs the Bellman-Ford algorithm from the given root
kpeter@697
   600
    /// node \c s in order to compute the shortest path distance for each
kpeter@697
   601
    /// node using only the paths consisting of at most \c num arcs.
kpeter@696
   602
    ///
kpeter@697
   603
    /// The algorithm computes
kpeter@697
   604
    /// - the limited distance of each node from the root(s),
kpeter@697
   605
    /// - the predecessor arc for each node.
kpeter@697
   606
    ///
kpeter@697
   607
    /// \warning The paths with limited arc number cannot be retrieved
kpeter@697
   608
    /// easily with \ref path() or \ref predArc() functions. If you also
kpeter@697
   609
    /// need the shortest paths and not only the distances, you should
kpeter@697
   610
    /// store the \ref predMap() "predecessor map" after each iteration
kpeter@697
   611
    /// and build the path manually.
kpeter@697
   612
    ///
kpeter@697
   613
    /// \note bf.run(s, num) is just a shortcut of the following code.
kpeter@697
   614
    /// \code
kpeter@697
   615
    ///   bf.init();
kpeter@697
   616
    ///   bf.addSource(s);
kpeter@697
   617
    ///   bf.limitedStart(num);
kpeter@697
   618
    /// \endcode
kpeter@696
   619
    void run(Node s, int num) {
kpeter@696
   620
      init();
kpeter@696
   621
      addSource(s);
kpeter@696
   622
      limitedStart(num);
kpeter@696
   623
    }
kpeter@696
   624
    
kpeter@696
   625
    ///@}
kpeter@696
   626
kpeter@697
   627
    /// \brief LEMON iterator for getting the active nodes.
kpeter@696
   628
    ///
kpeter@697
   629
    /// This class provides a common style LEMON iterator that traverses
kpeter@697
   630
    /// the active nodes of the Bellman-Ford algorithm after the last
kpeter@697
   631
    /// phase. These nodes should be checked in the next phase to
kpeter@697
   632
    /// find augmenting arcs outgoing from them.
kpeter@696
   633
    class ActiveIt {
kpeter@696
   634
    public:
kpeter@696
   635
kpeter@696
   636
      /// \brief Constructor.
kpeter@696
   637
      ///
kpeter@697
   638
      /// Constructor for getting the active nodes of the given BellmanFord
kpeter@697
   639
      /// instance. 
kpeter@696
   640
      ActiveIt(const BellmanFord& algorithm) : _algorithm(&algorithm)
kpeter@696
   641
      {
kpeter@696
   642
        _index = _algorithm->_process.size() - 1;
kpeter@696
   643
      }
kpeter@696
   644
kpeter@696
   645
      /// \brief Invalid constructor.
kpeter@696
   646
      ///
kpeter@696
   647
      /// Invalid constructor.
kpeter@696
   648
      ActiveIt(Invalid) : _algorithm(0), _index(-1) {}
kpeter@696
   649
kpeter@697
   650
      /// \brief Conversion to \c Node.
kpeter@696
   651
      ///
kpeter@697
   652
      /// Conversion to \c Node.
kpeter@696
   653
      operator Node() const { 
kpeter@696
   654
        return _index >= 0 ? _algorithm->_process[_index] : INVALID;
kpeter@696
   655
      }
kpeter@696
   656
kpeter@696
   657
      /// \brief Increment operator.
kpeter@696
   658
      ///
kpeter@696
   659
      /// Increment operator.
kpeter@696
   660
      ActiveIt& operator++() {
kpeter@696
   661
        --_index;
kpeter@696
   662
        return *this; 
kpeter@696
   663
      }
kpeter@696
   664
kpeter@696
   665
      bool operator==(const ActiveIt& it) const { 
kpeter@696
   666
        return static_cast<Node>(*this) == static_cast<Node>(it); 
kpeter@696
   667
      }
kpeter@696
   668
      bool operator!=(const ActiveIt& it) const { 
kpeter@696
   669
        return static_cast<Node>(*this) != static_cast<Node>(it); 
kpeter@696
   670
      }
kpeter@696
   671
      bool operator<(const ActiveIt& it) const { 
kpeter@696
   672
        return static_cast<Node>(*this) < static_cast<Node>(it); 
kpeter@696
   673
      }
kpeter@696
   674
      
kpeter@696
   675
    private:
kpeter@696
   676
      const BellmanFord* _algorithm;
kpeter@696
   677
      int _index;
kpeter@696
   678
    };
kpeter@697
   679
    
kpeter@697
   680
    /// \name Query Functions
kpeter@697
   681
    /// The result of the Bellman-Ford algorithm can be obtained using these
kpeter@697
   682
    /// functions.\n
kpeter@697
   683
    /// Either \ref run() or \ref init() should be called before using them.
kpeter@697
   684
    
kpeter@697
   685
    ///@{
kpeter@696
   686
kpeter@697
   687
    /// \brief The shortest path to the given node.
kpeter@697
   688
    ///    
kpeter@697
   689
    /// Gives back the shortest path to the given node from the root(s).
kpeter@697
   690
    ///
kpeter@697
   691
    /// \warning \c t should be reached from the root(s).
kpeter@697
   692
    ///
kpeter@697
   693
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@697
   694
    /// using this function.
kpeter@697
   695
    Path path(Node t) const
kpeter@697
   696
    {
kpeter@697
   697
      return Path(*_gr, *_pred, t);
kpeter@697
   698
    }
kpeter@697
   699
	  
kpeter@697
   700
    /// \brief The distance of the given node from the root(s).
kpeter@697
   701
    ///
kpeter@697
   702
    /// Returns the distance of the given node from the root(s).
kpeter@697
   703
    ///
kpeter@697
   704
    /// \warning If node \c v is not reached from the root(s), then
kpeter@697
   705
    /// the return value of this function is undefined.
kpeter@697
   706
    ///
kpeter@697
   707
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@697
   708
    /// using this function.
kpeter@697
   709
    Value dist(Node v) const { return (*_dist)[v]; }
kpeter@696
   710
kpeter@697
   711
    /// \brief Returns the 'previous arc' of the shortest path tree for
kpeter@697
   712
    /// the given node.
kpeter@697
   713
    ///
kpeter@697
   714
    /// This function returns the 'previous arc' of the shortest path
kpeter@697
   715
    /// tree for node \c v, i.e. it returns the last arc of a
kpeter@697
   716
    /// shortest path from a root to \c v. It is \c INVALID if \c v
kpeter@697
   717
    /// is not reached from the root(s) or if \c v is a root.
kpeter@697
   718
    ///
kpeter@697
   719
    /// The shortest path tree used here is equal to the shortest path
kpeter@697
   720
    /// tree used in \ref predNode() and \predMap().
kpeter@697
   721
    ///
kpeter@697
   722
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@697
   723
    /// using this function.
kpeter@697
   724
    Arc predArc(Node v) const { return (*_pred)[v]; }
kpeter@697
   725
kpeter@697
   726
    /// \brief Returns the 'previous node' of the shortest path tree for
kpeter@697
   727
    /// the given node.
kpeter@697
   728
    ///
kpeter@697
   729
    /// This function returns the 'previous node' of the shortest path
kpeter@697
   730
    /// tree for node \c v, i.e. it returns the last but one node of
kpeter@697
   731
    /// a shortest path from a root to \c v. It is \c INVALID if \c v
kpeter@697
   732
    /// is not reached from the root(s) or if \c v is a root.
kpeter@697
   733
    ///
kpeter@697
   734
    /// The shortest path tree used here is equal to the shortest path
kpeter@697
   735
    /// tree used in \ref predArc() and \predMap().
kpeter@697
   736
    ///
kpeter@697
   737
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@697
   738
    /// using this function.
kpeter@697
   739
    Node predNode(Node v) const { 
kpeter@697
   740
      return (*_pred)[v] == INVALID ? INVALID : _gr->source((*_pred)[v]); 
kpeter@697
   741
    }
kpeter@697
   742
    
kpeter@697
   743
    /// \brief Returns a const reference to the node map that stores the
kpeter@697
   744
    /// distances of the nodes.
kpeter@697
   745
    ///
kpeter@697
   746
    /// Returns a const reference to the node map that stores the distances
kpeter@697
   747
    /// of the nodes calculated by the algorithm.
kpeter@697
   748
    ///
kpeter@697
   749
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@697
   750
    /// using this function.
kpeter@697
   751
    const DistMap &distMap() const { return *_dist;}
kpeter@697
   752
 
kpeter@697
   753
    /// \brief Returns a const reference to the node map that stores the
kpeter@697
   754
    /// predecessor arcs.
kpeter@697
   755
    ///
kpeter@697
   756
    /// Returns a const reference to the node map that stores the predecessor
kpeter@697
   757
    /// arcs, which form the shortest path tree (forest).
kpeter@697
   758
    ///
kpeter@697
   759
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@697
   760
    /// using this function.
kpeter@697
   761
    const PredMap &predMap() const { return *_pred; }
kpeter@697
   762
 
kpeter@697
   763
    /// \brief Checks if a node is reached from the root(s).
kpeter@697
   764
    ///
kpeter@697
   765
    /// Returns \c true if \c v is reached from the root(s).
kpeter@697
   766
    ///
kpeter@697
   767
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@697
   768
    /// using this function.
kpeter@697
   769
    bool reached(Node v) const {
kpeter@697
   770
      return (*_dist)[v] != OperationTraits::infinity();
kpeter@696
   771
    }
kpeter@696
   772
kpeter@699
   773
    /// \brief Gives back a negative cycle.
kpeter@699
   774
    ///    
kpeter@699
   775
    /// This function gives back a directed cycle with negative total
kpeter@699
   776
    /// length if the algorithm has already found one.
kpeter@699
   777
    /// Otherwise it gives back an empty path.
kpeter@699
   778
    lemon::Path<Digraph> negativeCycle() {
kpeter@699
   779
      typename Digraph::template NodeMap<int> state(*_gr, -1);
kpeter@699
   780
      lemon::Path<Digraph> cycle;
kpeter@699
   781
      for (int i = 0; i < int(_process.size()); ++i) {
kpeter@699
   782
        if (state[_process[i]] != -1) continue;
kpeter@699
   783
        for (Node v = _process[i]; (*_pred)[v] != INVALID;
kpeter@699
   784
             v = _gr->source((*_pred)[v])) {
kpeter@699
   785
          if (state[v] == i) {
kpeter@699
   786
            cycle.addFront((*_pred)[v]);
kpeter@699
   787
            for (Node u = _gr->source((*_pred)[v]); u != v;
kpeter@699
   788
                 u = _gr->source((*_pred)[u])) {
kpeter@699
   789
              cycle.addFront((*_pred)[u]);
kpeter@699
   790
            }
kpeter@699
   791
            return cycle;
kpeter@699
   792
          }
kpeter@699
   793
          else if (state[v] >= 0) {
kpeter@699
   794
            break;
kpeter@699
   795
          }
kpeter@699
   796
          state[v] = i;
kpeter@699
   797
        }
kpeter@699
   798
      }
kpeter@699
   799
      return cycle;
kpeter@699
   800
    }
kpeter@696
   801
    
kpeter@696
   802
    ///@}
kpeter@696
   803
  };
kpeter@696
   804
 
kpeter@697
   805
  /// \brief Default traits class of bellmanFord() function.
kpeter@696
   806
  ///
kpeter@697
   807
  /// Default traits class of bellmanFord() function.
kpeter@697
   808
  /// \tparam GR The type of the digraph.
kpeter@697
   809
  /// \tparam LEN The type of the length map.
kpeter@697
   810
  template <typename GR, typename LEN>
kpeter@696
   811
  struct BellmanFordWizardDefaultTraits {
kpeter@697
   812
    /// The type of the digraph the algorithm runs on. 
kpeter@697
   813
    typedef GR Digraph;
kpeter@696
   814
kpeter@696
   815
    /// \brief The type of the map that stores the arc lengths.
kpeter@696
   816
    ///
kpeter@696
   817
    /// The type of the map that stores the arc lengths.
kpeter@696
   818
    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
kpeter@697
   819
    typedef LEN LengthMap;
kpeter@696
   820
kpeter@697
   821
    /// The type of the arc lengths.
kpeter@697
   822
    typedef typename LEN::Value Value;
kpeter@696
   823
kpeter@696
   824
    /// \brief Operation traits for Bellman-Ford algorithm.
kpeter@696
   825
    ///
kpeter@697
   826
    /// It defines the used operations and the infinity value for the
kpeter@697
   827
    /// given \c Value type.
kpeter@696
   828
    /// \see BellmanFordDefaultOperationTraits
kpeter@696
   829
    typedef BellmanFordDefaultOperationTraits<Value> OperationTraits;
kpeter@696
   830
kpeter@696
   831
    /// \brief The type of the map that stores the last
kpeter@696
   832
    /// arcs of the shortest paths.
kpeter@696
   833
    /// 
kpeter@697
   834
    /// The type of the map that stores the last arcs of the shortest paths.
kpeter@697
   835
    /// It must conform to the \ref concepts::WriteMap "WriteMap" concept.
kpeter@697
   836
    typedef typename GR::template NodeMap<typename GR::Arc> PredMap;
kpeter@696
   837
kpeter@697
   838
    /// \brief Instantiates a \c PredMap.
kpeter@696
   839
    /// 
kpeter@697
   840
    /// This function instantiates a \ref PredMap.
kpeter@697
   841
    /// \param g is the digraph to which we would like to define the
kpeter@697
   842
    /// \ref PredMap.
kpeter@697
   843
    static PredMap *createPredMap(const GR &g) {
kpeter@697
   844
      return new PredMap(g);
kpeter@696
   845
    }
kpeter@697
   846
kpeter@697
   847
    /// \brief The type of the map that stores the distances of the nodes.
kpeter@696
   848
    ///
kpeter@697
   849
    /// The type of the map that stores the distances of the nodes.
kpeter@697
   850
    /// It must conform to the \ref concepts::WriteMap "WriteMap" concept.
kpeter@697
   851
    typedef typename GR::template NodeMap<Value> DistMap;
kpeter@697
   852
kpeter@697
   853
    /// \brief Instantiates a \c DistMap.
kpeter@696
   854
    ///
kpeter@696
   855
    /// This function instantiates a \ref DistMap. 
kpeter@697
   856
    /// \param g is the digraph to which we would like to define the
kpeter@697
   857
    /// \ref DistMap.
kpeter@697
   858
    static DistMap *createDistMap(const GR &g) {
kpeter@697
   859
      return new DistMap(g);
kpeter@696
   860
    }
kpeter@697
   861
kpeter@697
   862
    ///The type of the shortest paths.
kpeter@697
   863
kpeter@697
   864
    ///The type of the shortest paths.
kpeter@697
   865
    ///It must meet the \ref concepts::Path "Path" concept.
kpeter@697
   866
    typedef lemon::Path<Digraph> Path;
kpeter@696
   867
  };
kpeter@696
   868
  
kpeter@697
   869
  /// \brief Default traits class used by BellmanFordWizard.
kpeter@696
   870
  ///
kpeter@697
   871
  /// Default traits class used by BellmanFordWizard.
kpeter@697
   872
  /// \tparam GR The type of the digraph.
kpeter@697
   873
  /// \tparam LEN The type of the length map.
kpeter@697
   874
  template <typename GR, typename LEN>
kpeter@696
   875
  class BellmanFordWizardBase 
kpeter@697
   876
    : public BellmanFordWizardDefaultTraits<GR, LEN> {
kpeter@696
   877
kpeter@697
   878
    typedef BellmanFordWizardDefaultTraits<GR, LEN> Base;
kpeter@696
   879
  protected:
kpeter@697
   880
    // Type of the nodes in the digraph.
kpeter@696
   881
    typedef typename Base::Digraph::Node Node;
kpeter@696
   882
kpeter@697
   883
    // Pointer to the underlying digraph.
kpeter@696
   884
    void *_graph;
kpeter@697
   885
    // Pointer to the length map
kpeter@696
   886
    void *_length;
kpeter@697
   887
    // Pointer to the map of predecessors arcs.
kpeter@696
   888
    void *_pred;
kpeter@697
   889
    // Pointer to the map of distances.
kpeter@696
   890
    void *_dist;
kpeter@697
   891
    //Pointer to the shortest path to the target node.
kpeter@697
   892
    void *_path;
kpeter@697
   893
    //Pointer to the distance of the target node.
kpeter@697
   894
    void *_di;
kpeter@696
   895
kpeter@696
   896
    public:
kpeter@696
   897
    /// Constructor.
kpeter@696
   898
    
kpeter@697
   899
    /// This constructor does not require parameters, it initiates
kpeter@697
   900
    /// all of the attributes to default values \c 0.
kpeter@697
   901
    BellmanFordWizardBase() :
kpeter@697
   902
      _graph(0), _length(0), _pred(0), _dist(0), _path(0), _di(0) {}
kpeter@696
   903
kpeter@696
   904
    /// Constructor.
kpeter@696
   905
    
kpeter@697
   906
    /// This constructor requires two parameters,
kpeter@697
   907
    /// others are initiated to \c 0.
kpeter@697
   908
    /// \param gr The digraph the algorithm runs on.
kpeter@697
   909
    /// \param len The length map.
kpeter@697
   910
    BellmanFordWizardBase(const GR& gr, 
kpeter@697
   911
			  const LEN& len) :
kpeter@697
   912
      _graph(reinterpret_cast<void*>(const_cast<GR*>(&gr))), 
kpeter@697
   913
      _length(reinterpret_cast<void*>(const_cast<LEN*>(&len))), 
kpeter@697
   914
      _pred(0), _dist(0), _path(0), _di(0) {}
kpeter@696
   915
kpeter@696
   916
  };
kpeter@696
   917
  
kpeter@697
   918
  /// \brief Auxiliary class for the function-type interface of the
kpeter@697
   919
  /// \ref BellmanFord "Bellman-Ford" algorithm.
kpeter@697
   920
  ///
kpeter@697
   921
  /// This auxiliary class is created to implement the
kpeter@697
   922
  /// \ref bellmanFord() "function-type interface" of the
kpeter@697
   923
  /// \ref BellmanFord "Bellman-Ford" algorithm.
kpeter@697
   924
  /// It does not have own \ref run() method, it uses the
kpeter@697
   925
  /// functions and features of the plain \ref BellmanFord.
kpeter@697
   926
  ///
kpeter@697
   927
  /// This class should only be used through the \ref bellmanFord()
kpeter@697
   928
  /// function, which makes it easier to use the algorithm.
kpeter@697
   929
  template<class TR>
kpeter@697
   930
  class BellmanFordWizard : public TR {
kpeter@697
   931
    typedef TR Base;
kpeter@696
   932
kpeter@697
   933
    typedef typename TR::Digraph Digraph;
kpeter@696
   934
kpeter@696
   935
    typedef typename Digraph::Node Node;
kpeter@696
   936
    typedef typename Digraph::NodeIt NodeIt;
kpeter@696
   937
    typedef typename Digraph::Arc Arc;
kpeter@696
   938
    typedef typename Digraph::OutArcIt ArcIt;
kpeter@696
   939
    
kpeter@697
   940
    typedef typename TR::LengthMap LengthMap;
kpeter@696
   941
    typedef typename LengthMap::Value Value;
kpeter@697
   942
    typedef typename TR::PredMap PredMap;
kpeter@697
   943
    typedef typename TR::DistMap DistMap;
kpeter@697
   944
    typedef typename TR::Path Path;
kpeter@696
   945
kpeter@696
   946
  public:
kpeter@696
   947
    /// Constructor.
kpeter@697
   948
    BellmanFordWizard() : TR() {}
kpeter@696
   949
kpeter@696
   950
    /// \brief Constructor that requires parameters.
kpeter@696
   951
    ///
kpeter@696
   952
    /// Constructor that requires parameters.
kpeter@696
   953
    /// These parameters will be the default values for the traits class.
kpeter@697
   954
    /// \param gr The digraph the algorithm runs on.
kpeter@697
   955
    /// \param len The length map.
kpeter@697
   956
    BellmanFordWizard(const Digraph& gr, const LengthMap& len) 
kpeter@697
   957
      : TR(gr, len) {}
kpeter@696
   958
kpeter@696
   959
    /// \brief Copy constructor
kpeter@697
   960
    BellmanFordWizard(const TR &b) : TR(b) {}
kpeter@696
   961
kpeter@696
   962
    ~BellmanFordWizard() {}
kpeter@696
   963
kpeter@697
   964
    /// \brief Runs the Bellman-Ford algorithm from the given source node.
kpeter@696
   965
    ///    
kpeter@697
   966
    /// This method runs the Bellman-Ford algorithm from the given source
kpeter@697
   967
    /// node in order to compute the shortest path to each node.
kpeter@697
   968
    void run(Node s) {
kpeter@697
   969
      BellmanFord<Digraph,LengthMap,TR> 
kpeter@696
   970
	bf(*reinterpret_cast<const Digraph*>(Base::_graph), 
kpeter@696
   971
           *reinterpret_cast<const LengthMap*>(Base::_length));
kpeter@696
   972
      if (Base::_pred) bf.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
kpeter@696
   973
      if (Base::_dist) bf.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
kpeter@697
   974
      bf.run(s);
kpeter@696
   975
    }
kpeter@696
   976
kpeter@697
   977
    /// \brief Runs the Bellman-Ford algorithm to find the shortest path
kpeter@697
   978
    /// between \c s and \c t.
kpeter@696
   979
    ///
kpeter@697
   980
    /// This method runs the Bellman-Ford algorithm from node \c s
kpeter@697
   981
    /// in order to compute the shortest path to node \c t.
kpeter@697
   982
    /// Actually, it computes the shortest path to each node, but using
kpeter@697
   983
    /// this function you can retrieve the distance and the shortest path
kpeter@697
   984
    /// for a single target node easier.
kpeter@697
   985
    ///
kpeter@697
   986
    /// \return \c true if \c t is reachable form \c s.
kpeter@697
   987
    bool run(Node s, Node t) {
kpeter@697
   988
      BellmanFord<Digraph,LengthMap,TR>
kpeter@697
   989
        bf(*reinterpret_cast<const Digraph*>(Base::_graph),
kpeter@697
   990
           *reinterpret_cast<const LengthMap*>(Base::_length));
kpeter@697
   991
      if (Base::_pred) bf.predMap(*reinterpret_cast<PredMap*>(Base::_pred));
kpeter@697
   992
      if (Base::_dist) bf.distMap(*reinterpret_cast<DistMap*>(Base::_dist));
kpeter@697
   993
      bf.run(s);
kpeter@697
   994
      if (Base::_path) *reinterpret_cast<Path*>(Base::_path) = bf.path(t);
kpeter@697
   995
      if (Base::_di) *reinterpret_cast<Value*>(Base::_di) = bf.dist(t);
kpeter@697
   996
      return bf.reached(t);
kpeter@696
   997
    }
kpeter@696
   998
kpeter@696
   999
    template<class T>
kpeter@697
  1000
    struct SetPredMapBase : public Base {
kpeter@696
  1001
      typedef T PredMap;
kpeter@696
  1002
      static PredMap *createPredMap(const Digraph &) { return 0; };
kpeter@697
  1003
      SetPredMapBase(const TR &b) : TR(b) {}
kpeter@696
  1004
    };
kpeter@696
  1005
    
kpeter@697
  1006
    /// \brief \ref named-templ-param "Named parameter" for setting
kpeter@697
  1007
    /// the predecessor map.
kpeter@696
  1008
    ///
kpeter@697
  1009
    /// \ref named-templ-param "Named parameter" for setting
kpeter@697
  1010
    /// the map that stores the predecessor arcs of the nodes.
kpeter@696
  1011
    template<class T>
kpeter@697
  1012
    BellmanFordWizard<SetPredMapBase<T> > predMap(const T &t) {
kpeter@696
  1013
      Base::_pred=reinterpret_cast<void*>(const_cast<T*>(&t));
kpeter@697
  1014
      return BellmanFordWizard<SetPredMapBase<T> >(*this);
kpeter@696
  1015
    }
kpeter@696
  1016
    
kpeter@696
  1017
    template<class T>
kpeter@697
  1018
    struct SetDistMapBase : public Base {
kpeter@696
  1019
      typedef T DistMap;
kpeter@696
  1020
      static DistMap *createDistMap(const Digraph &) { return 0; };
kpeter@697
  1021
      SetDistMapBase(const TR &b) : TR(b) {}
kpeter@696
  1022
    };
kpeter@696
  1023
    
kpeter@697
  1024
    /// \brief \ref named-templ-param "Named parameter" for setting
kpeter@697
  1025
    /// the distance map.
kpeter@696
  1026
    ///
kpeter@697
  1027
    /// \ref named-templ-param "Named parameter" for setting
kpeter@697
  1028
    /// the map that stores the distances of the nodes calculated
kpeter@697
  1029
    /// by the algorithm.
kpeter@696
  1030
    template<class T>
kpeter@697
  1031
    BellmanFordWizard<SetDistMapBase<T> > distMap(const T &t) {
kpeter@696
  1032
      Base::_dist=reinterpret_cast<void*>(const_cast<T*>(&t));
kpeter@697
  1033
      return BellmanFordWizard<SetDistMapBase<T> >(*this);
kpeter@696
  1034
    }
kpeter@696
  1035
kpeter@696
  1036
    template<class T>
kpeter@697
  1037
    struct SetPathBase : public Base {
kpeter@697
  1038
      typedef T Path;
kpeter@697
  1039
      SetPathBase(const TR &b) : TR(b) {}
kpeter@696
  1040
    };
kpeter@697
  1041
kpeter@697
  1042
    /// \brief \ref named-func-param "Named parameter" for getting
kpeter@697
  1043
    /// the shortest path to the target node.
kpeter@696
  1044
    ///
kpeter@697
  1045
    /// \ref named-func-param "Named parameter" for getting
kpeter@697
  1046
    /// the shortest path to the target node.
kpeter@697
  1047
    template<class T>
kpeter@697
  1048
    BellmanFordWizard<SetPathBase<T> > path(const T &t)
kpeter@697
  1049
    {
kpeter@697
  1050
      Base::_path=reinterpret_cast<void*>(const_cast<T*>(&t));
kpeter@697
  1051
      return BellmanFordWizard<SetPathBase<T> >(*this);
kpeter@697
  1052
    }
kpeter@697
  1053
kpeter@697
  1054
    /// \brief \ref named-func-param "Named parameter" for getting
kpeter@697
  1055
    /// the distance of the target node.
kpeter@696
  1056
    ///
kpeter@697
  1057
    /// \ref named-func-param "Named parameter" for getting
kpeter@697
  1058
    /// the distance of the target node.
kpeter@697
  1059
    BellmanFordWizard dist(const Value &d)
kpeter@697
  1060
    {
kpeter@697
  1061
      Base::_di=reinterpret_cast<void*>(const_cast<Value*>(&d));
kpeter@696
  1062
      return *this;
kpeter@696
  1063
    }
kpeter@696
  1064
    
kpeter@696
  1065
  };
kpeter@696
  1066
  
kpeter@697
  1067
  /// \brief Function type interface for the \ref BellmanFord "Bellman-Ford"
kpeter@697
  1068
  /// algorithm.
kpeter@696
  1069
  ///
kpeter@696
  1070
  /// \ingroup shortest_path
kpeter@697
  1071
  /// Function type interface for the \ref BellmanFord "Bellman-Ford"
kpeter@697
  1072
  /// algorithm.
kpeter@696
  1073
  ///
kpeter@696
  1074
  /// This function also has several \ref named-templ-func-param 
kpeter@696
  1075
  /// "named parameters", they are declared as the members of class 
kpeter@696
  1076
  /// \ref BellmanFordWizard.
kpeter@697
  1077
  /// The following examples show how to use these parameters.
kpeter@697
  1078
  /// \code
kpeter@697
  1079
  ///   // Compute shortest path from node s to each node
kpeter@697
  1080
  ///   bellmanFord(g,length).predMap(preds).distMap(dists).run(s);
kpeter@697
  1081
  ///
kpeter@697
  1082
  ///   // Compute shortest path from s to t
kpeter@697
  1083
  ///   bool reached = bellmanFord(g,length).path(p).dist(d).run(s,t);
kpeter@697
  1084
  /// \endcode
kpeter@696
  1085
  /// \warning Don't forget to put the \ref BellmanFordWizard::run() "run()"
kpeter@696
  1086
  /// to the end of the parameter list.
kpeter@696
  1087
  /// \sa BellmanFordWizard
kpeter@696
  1088
  /// \sa BellmanFord
kpeter@697
  1089
  template<typename GR, typename LEN>
kpeter@697
  1090
  BellmanFordWizard<BellmanFordWizardBase<GR,LEN> >
kpeter@697
  1091
  bellmanFord(const GR& digraph,
kpeter@697
  1092
	      const LEN& length)
kpeter@697
  1093
  {
kpeter@697
  1094
    return BellmanFordWizard<BellmanFordWizardBase<GR,LEN> >(digraph, length);
kpeter@696
  1095
  }
kpeter@696
  1096
kpeter@696
  1097
} //END OF NAMESPACE LEMON
kpeter@696
  1098
kpeter@696
  1099
#endif
kpeter@696
  1100