lemon/cycle_canceling.h
author Peter Kovacs <kpeter@inf.elte.hu>
Wed, 17 Feb 2010 23:10:36 +0100
changeset 836 c841ae1aca29
parent 820 7ef7a5fbb85d
child 840 2914b6f0fde0
permissions -rw-r--r--
Modify the header of scripts/bib2dox.py (#184)
kpeter@814
     1
/* -*- C++ -*-
kpeter@814
     2
 *
kpeter@814
     3
 * This file is a part of LEMON, a generic C++ optimization library
kpeter@814
     4
 *
kpeter@814
     5
 * Copyright (C) 2003-2008
kpeter@814
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@814
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@814
     8
 *
kpeter@814
     9
 * Permission to use, modify and distribute this software is granted
kpeter@814
    10
 * provided that this copyright notice appears in all copies. For
kpeter@814
    11
 * precise terms see the accompanying LICENSE file.
kpeter@814
    12
 *
kpeter@814
    13
 * This software is provided "AS IS" with no warranty of any kind,
kpeter@814
    14
 * express or implied, and with no claim as to its suitability for any
kpeter@814
    15
 * purpose.
kpeter@814
    16
 *
kpeter@814
    17
 */
kpeter@814
    18
kpeter@814
    19
#ifndef LEMON_CYCLE_CANCELING_H
kpeter@814
    20
#define LEMON_CYCLE_CANCELING_H
kpeter@814
    21
kpeter@815
    22
/// \ingroup min_cost_flow_algs
kpeter@814
    23
/// \file
kpeter@815
    24
/// \brief Cycle-canceling algorithms for finding a minimum cost flow.
kpeter@814
    25
kpeter@814
    26
#include <vector>
kpeter@815
    27
#include <limits>
kpeter@815
    28
kpeter@815
    29
#include <lemon/core.h>
kpeter@815
    30
#include <lemon/maps.h>
kpeter@815
    31
#include <lemon/path.h>
kpeter@815
    32
#include <lemon/math.h>
kpeter@815
    33
#include <lemon/static_graph.h>
kpeter@814
    34
#include <lemon/adaptors.h>
kpeter@814
    35
#include <lemon/circulation.h>
kpeter@814
    36
#include <lemon/bellman_ford.h>
kpeter@814
    37
#include <lemon/howard.h>
kpeter@814
    38
kpeter@814
    39
namespace lemon {
kpeter@814
    40
kpeter@815
    41
  /// \addtogroup min_cost_flow_algs
kpeter@814
    42
  /// @{
kpeter@814
    43
kpeter@815
    44
  /// \brief Implementation of cycle-canceling algorithms for
kpeter@815
    45
  /// finding a \ref min_cost_flow "minimum cost flow".
kpeter@814
    46
  ///
kpeter@815
    47
  /// \ref CycleCanceling implements three different cycle-canceling
kpeter@816
    48
  /// algorithms for finding a \ref min_cost_flow "minimum cost flow"
kpeter@816
    49
  /// \ref amo93networkflows, \ref klein67primal,
kpeter@816
    50
  /// \ref goldberg89cyclecanceling.
kpeter@815
    51
  /// The most efficent one (both theoretically and practically)
kpeter@815
    52
  /// is the \ref CANCEL_AND_TIGHTEN "Cancel and Tighten" algorithm,
kpeter@815
    53
  /// thus it is the default method.
kpeter@815
    54
  /// It is strongly polynomial, but in practice, it is typically much
kpeter@815
    55
  /// slower than the scaling algorithms and NetworkSimplex.
kpeter@814
    56
  ///
kpeter@815
    57
  /// Most of the parameters of the problem (except for the digraph)
kpeter@815
    58
  /// can be given using separate functions, and the algorithm can be
kpeter@815
    59
  /// executed using the \ref run() function. If some parameters are not
kpeter@815
    60
  /// specified, then default values will be used.
kpeter@814
    61
  ///
kpeter@815
    62
  /// \tparam GR The digraph type the algorithm runs on.
kpeter@815
    63
  /// \tparam V The number type used for flow amounts, capacity bounds
kpeter@815
    64
  /// and supply values in the algorithm. By default, it is \c int.
kpeter@815
    65
  /// \tparam C The number type used for costs and potentials in the
kpeter@815
    66
  /// algorithm. By default, it is the same as \c V.
kpeter@814
    67
  ///
kpeter@815
    68
  /// \warning Both number types must be signed and all input data must
kpeter@815
    69
  /// be integer.
kpeter@815
    70
  /// \warning This algorithm does not support negative costs for such
kpeter@815
    71
  /// arcs that have infinite upper bound.
kpeter@814
    72
  ///
kpeter@815
    73
  /// \note For more information about the three available methods,
kpeter@815
    74
  /// see \ref Method.
kpeter@815
    75
#ifdef DOXYGEN
kpeter@815
    76
  template <typename GR, typename V, typename C>
kpeter@815
    77
#else
kpeter@815
    78
  template <typename GR, typename V = int, typename C = V>
kpeter@815
    79
#endif
kpeter@814
    80
  class CycleCanceling
kpeter@814
    81
  {
kpeter@815
    82
  public:
kpeter@814
    83
kpeter@815
    84
    /// The type of the digraph
kpeter@815
    85
    typedef GR Digraph;
kpeter@815
    86
    /// The type of the flow amounts, capacity bounds and supply values
kpeter@815
    87
    typedef V Value;
kpeter@815
    88
    /// The type of the arc costs
kpeter@815
    89
    typedef C Cost;
kpeter@814
    90
kpeter@814
    91
  public:
kpeter@814
    92
kpeter@815
    93
    /// \brief Problem type constants for the \c run() function.
kpeter@815
    94
    ///
kpeter@815
    95
    /// Enum type containing the problem type constants that can be
kpeter@815
    96
    /// returned by the \ref run() function of the algorithm.
kpeter@815
    97
    enum ProblemType {
kpeter@815
    98
      /// The problem has no feasible solution (flow).
kpeter@815
    99
      INFEASIBLE,
kpeter@815
   100
      /// The problem has optimal solution (i.e. it is feasible and
kpeter@815
   101
      /// bounded), and the algorithm has found optimal flow and node
kpeter@815
   102
      /// potentials (primal and dual solutions).
kpeter@815
   103
      OPTIMAL,
kpeter@815
   104
      /// The digraph contains an arc of negative cost and infinite
kpeter@815
   105
      /// upper bound. It means that the objective function is unbounded
kpeter@815
   106
      /// on that arc, however, note that it could actually be bounded
kpeter@815
   107
      /// over the feasible flows, but this algroithm cannot handle
kpeter@815
   108
      /// these cases.
kpeter@815
   109
      UNBOUNDED
kpeter@815
   110
    };
kpeter@815
   111
kpeter@815
   112
    /// \brief Constants for selecting the used method.
kpeter@815
   113
    ///
kpeter@815
   114
    /// Enum type containing constants for selecting the used method
kpeter@815
   115
    /// for the \ref run() function.
kpeter@815
   116
    ///
kpeter@815
   117
    /// \ref CycleCanceling provides three different cycle-canceling
kpeter@815
   118
    /// methods. By default, \ref CANCEL_AND_TIGHTEN "Cancel and Tighten"
kpeter@815
   119
    /// is used, which proved to be the most efficient and the most robust
kpeter@815
   120
    /// on various test inputs.
kpeter@815
   121
    /// However, the other methods can be selected using the \ref run()
kpeter@815
   122
    /// function with the proper parameter.
kpeter@815
   123
    enum Method {
kpeter@815
   124
      /// A simple cycle-canceling method, which uses the
kpeter@815
   125
      /// \ref BellmanFord "Bellman-Ford" algorithm with limited iteration
kpeter@815
   126
      /// number for detecting negative cycles in the residual network.
kpeter@815
   127
      SIMPLE_CYCLE_CANCELING,
kpeter@815
   128
      /// The "Minimum Mean Cycle-Canceling" algorithm, which is a
kpeter@816
   129
      /// well-known strongly polynomial method
kpeter@816
   130
      /// \ref goldberg89cyclecanceling. It improves along a
kpeter@815
   131
      /// \ref min_mean_cycle "minimum mean cycle" in each iteration.
kpeter@815
   132
      /// Its running time complexity is O(n<sup>2</sup>m<sup>3</sup>log(n)).
kpeter@815
   133
      MINIMUM_MEAN_CYCLE_CANCELING,
kpeter@815
   134
      /// The "Cancel And Tighten" algorithm, which can be viewed as an
kpeter@816
   135
      /// improved version of the previous method
kpeter@816
   136
      /// \ref goldberg89cyclecanceling.
kpeter@815
   137
      /// It is faster both in theory and in practice, its running time
kpeter@815
   138
      /// complexity is O(n<sup>2</sup>m<sup>2</sup>log(n)).
kpeter@815
   139
      CANCEL_AND_TIGHTEN
kpeter@815
   140
    };
kpeter@814
   141
kpeter@814
   142
  private:
kpeter@814
   143
kpeter@815
   144
    TEMPLATE_DIGRAPH_TYPEDEFS(GR);
kpeter@815
   145
    
kpeter@815
   146
    typedef std::vector<int> IntVector;
kpeter@815
   147
    typedef std::vector<char> CharVector;
kpeter@815
   148
    typedef std::vector<double> DoubleVector;
kpeter@815
   149
    typedef std::vector<Value> ValueVector;
kpeter@815
   150
    typedef std::vector<Cost> CostVector;
kpeter@814
   151
kpeter@815
   152
  private:
kpeter@815
   153
  
kpeter@815
   154
    template <typename KT, typename VT>
kpeter@820
   155
    class StaticVectorMap {
kpeter@814
   156
    public:
kpeter@815
   157
      typedef KT Key;
kpeter@815
   158
      typedef VT Value;
kpeter@815
   159
      
kpeter@820
   160
      StaticVectorMap(std::vector<Value>& v) : _v(v) {}
kpeter@815
   161
      
kpeter@815
   162
      const Value& operator[](const Key& key) const {
kpeter@815
   163
        return _v[StaticDigraph::id(key)];
kpeter@814
   164
      }
kpeter@814
   165
kpeter@815
   166
      Value& operator[](const Key& key) {
kpeter@815
   167
        return _v[StaticDigraph::id(key)];
kpeter@815
   168
      }
kpeter@815
   169
      
kpeter@815
   170
      void set(const Key& key, const Value& val) {
kpeter@815
   171
        _v[StaticDigraph::id(key)] = val;
kpeter@815
   172
      }
kpeter@815
   173
kpeter@815
   174
    private:
kpeter@815
   175
      std::vector<Value>& _v;
kpeter@815
   176
    };
kpeter@815
   177
kpeter@820
   178
    typedef StaticVectorMap<StaticDigraph::Node, Cost> CostNodeMap;
kpeter@820
   179
    typedef StaticVectorMap<StaticDigraph::Arc, Cost> CostArcMap;
kpeter@814
   180
kpeter@814
   181
  private:
kpeter@814
   182
kpeter@814
   183
kpeter@815
   184
    // Data related to the underlying digraph
kpeter@815
   185
    const GR &_graph;
kpeter@815
   186
    int _node_num;
kpeter@815
   187
    int _arc_num;
kpeter@815
   188
    int _res_node_num;
kpeter@815
   189
    int _res_arc_num;
kpeter@815
   190
    int _root;
kpeter@814
   191
kpeter@815
   192
    // Parameters of the problem
kpeter@815
   193
    bool _have_lower;
kpeter@815
   194
    Value _sum_supply;
kpeter@814
   195
kpeter@815
   196
    // Data structures for storing the digraph
kpeter@815
   197
    IntNodeMap _node_id;
kpeter@815
   198
    IntArcMap _arc_idf;
kpeter@815
   199
    IntArcMap _arc_idb;
kpeter@815
   200
    IntVector _first_out;
kpeter@815
   201
    CharVector _forward;
kpeter@815
   202
    IntVector _source;
kpeter@815
   203
    IntVector _target;
kpeter@815
   204
    IntVector _reverse;
kpeter@814
   205
kpeter@815
   206
    // Node and arc data
kpeter@815
   207
    ValueVector _lower;
kpeter@815
   208
    ValueVector _upper;
kpeter@815
   209
    CostVector _cost;
kpeter@815
   210
    ValueVector _supply;
kpeter@815
   211
kpeter@815
   212
    ValueVector _res_cap;
kpeter@815
   213
    CostVector _pi;
kpeter@815
   214
kpeter@815
   215
    // Data for a StaticDigraph structure
kpeter@815
   216
    typedef std::pair<int, int> IntPair;
kpeter@815
   217
    StaticDigraph _sgr;
kpeter@815
   218
    std::vector<IntPair> _arc_vec;
kpeter@815
   219
    std::vector<Cost> _cost_vec;
kpeter@815
   220
    IntVector _id_vec;
kpeter@815
   221
    CostArcMap _cost_map;
kpeter@815
   222
    CostNodeMap _pi_map;
kpeter@815
   223
  
kpeter@815
   224
  public:
kpeter@815
   225
  
kpeter@815
   226
    /// \brief Constant for infinite upper bounds (capacities).
kpeter@815
   227
    ///
kpeter@815
   228
    /// Constant for infinite upper bounds (capacities).
kpeter@815
   229
    /// It is \c std::numeric_limits<Value>::infinity() if available,
kpeter@815
   230
    /// \c std::numeric_limits<Value>::max() otherwise.
kpeter@815
   231
    const Value INF;
kpeter@814
   232
kpeter@814
   233
  public:
kpeter@814
   234
kpeter@815
   235
    /// \brief Constructor.
kpeter@814
   236
    ///
kpeter@815
   237
    /// The constructor of the class.
kpeter@814
   238
    ///
kpeter@815
   239
    /// \param graph The digraph the algorithm runs on.
kpeter@815
   240
    CycleCanceling(const GR& graph) :
kpeter@815
   241
      _graph(graph), _node_id(graph), _arc_idf(graph), _arc_idb(graph),
kpeter@815
   242
      _cost_map(_cost_vec), _pi_map(_pi),
kpeter@815
   243
      INF(std::numeric_limits<Value>::has_infinity ?
kpeter@815
   244
          std::numeric_limits<Value>::infinity() :
kpeter@815
   245
          std::numeric_limits<Value>::max())
kpeter@814
   246
    {
kpeter@815
   247
      // Check the number types
kpeter@815
   248
      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
kpeter@815
   249
        "The flow type of CycleCanceling must be signed");
kpeter@815
   250
      LEMON_ASSERT(std::numeric_limits<Cost>::is_signed,
kpeter@815
   251
        "The cost type of CycleCanceling must be signed");
kpeter@815
   252
kpeter@830
   253
      // Reset data structures
kpeter@815
   254
      reset();
kpeter@814
   255
    }
kpeter@814
   256
kpeter@815
   257
    /// \name Parameters
kpeter@815
   258
    /// The parameters of the algorithm can be specified using these
kpeter@815
   259
    /// functions.
kpeter@815
   260
kpeter@815
   261
    /// @{
kpeter@815
   262
kpeter@815
   263
    /// \brief Set the lower bounds on the arcs.
kpeter@814
   264
    ///
kpeter@815
   265
    /// This function sets the lower bounds on the arcs.
kpeter@815
   266
    /// If it is not used before calling \ref run(), the lower bounds
kpeter@815
   267
    /// will be set to zero on all arcs.
kpeter@814
   268
    ///
kpeter@815
   269
    /// \param map An arc map storing the lower bounds.
kpeter@815
   270
    /// Its \c Value type must be convertible to the \c Value type
kpeter@815
   271
    /// of the algorithm.
kpeter@815
   272
    ///
kpeter@815
   273
    /// \return <tt>(*this)</tt>
kpeter@815
   274
    template <typename LowerMap>
kpeter@815
   275
    CycleCanceling& lowerMap(const LowerMap& map) {
kpeter@815
   276
      _have_lower = true;
kpeter@815
   277
      for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   278
        _lower[_arc_idf[a]] = map[a];
kpeter@815
   279
        _lower[_arc_idb[a]] = map[a];
kpeter@814
   280
      }
kpeter@814
   281
      return *this;
kpeter@814
   282
    }
kpeter@814
   283
kpeter@815
   284
    /// \brief Set the upper bounds (capacities) on the arcs.
kpeter@814
   285
    ///
kpeter@815
   286
    /// This function sets the upper bounds (capacities) on the arcs.
kpeter@815
   287
    /// If it is not used before calling \ref run(), the upper bounds
kpeter@815
   288
    /// will be set to \ref INF on all arcs (i.e. the flow value will be
kpeter@815
   289
    /// unbounded from above).
kpeter@814
   290
    ///
kpeter@815
   291
    /// \param map An arc map storing the upper bounds.
kpeter@815
   292
    /// Its \c Value type must be convertible to the \c Value type
kpeter@815
   293
    /// of the algorithm.
kpeter@815
   294
    ///
kpeter@815
   295
    /// \return <tt>(*this)</tt>
kpeter@815
   296
    template<typename UpperMap>
kpeter@815
   297
    CycleCanceling& upperMap(const UpperMap& map) {
kpeter@815
   298
      for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   299
        _upper[_arc_idf[a]] = map[a];
kpeter@814
   300
      }
kpeter@814
   301
      return *this;
kpeter@814
   302
    }
kpeter@814
   303
kpeter@815
   304
    /// \brief Set the costs of the arcs.
kpeter@815
   305
    ///
kpeter@815
   306
    /// This function sets the costs of the arcs.
kpeter@815
   307
    /// If it is not used before calling \ref run(), the costs
kpeter@815
   308
    /// will be set to \c 1 on all arcs.
kpeter@815
   309
    ///
kpeter@815
   310
    /// \param map An arc map storing the costs.
kpeter@815
   311
    /// Its \c Value type must be convertible to the \c Cost type
kpeter@815
   312
    /// of the algorithm.
kpeter@815
   313
    ///
kpeter@815
   314
    /// \return <tt>(*this)</tt>
kpeter@815
   315
    template<typename CostMap>
kpeter@815
   316
    CycleCanceling& costMap(const CostMap& map) {
kpeter@815
   317
      for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   318
        _cost[_arc_idf[a]] =  map[a];
kpeter@815
   319
        _cost[_arc_idb[a]] = -map[a];
kpeter@815
   320
      }
kpeter@815
   321
      return *this;
kpeter@815
   322
    }
kpeter@815
   323
kpeter@815
   324
    /// \brief Set the supply values of the nodes.
kpeter@815
   325
    ///
kpeter@815
   326
    /// This function sets the supply values of the nodes.
kpeter@815
   327
    /// If neither this function nor \ref stSupply() is used before
kpeter@815
   328
    /// calling \ref run(), the supply of each node will be set to zero.
kpeter@815
   329
    ///
kpeter@815
   330
    /// \param map A node map storing the supply values.
kpeter@815
   331
    /// Its \c Value type must be convertible to the \c Value type
kpeter@815
   332
    /// of the algorithm.
kpeter@815
   333
    ///
kpeter@815
   334
    /// \return <tt>(*this)</tt>
kpeter@815
   335
    template<typename SupplyMap>
kpeter@815
   336
    CycleCanceling& supplyMap(const SupplyMap& map) {
kpeter@815
   337
      for (NodeIt n(_graph); n != INVALID; ++n) {
kpeter@815
   338
        _supply[_node_id[n]] = map[n];
kpeter@815
   339
      }
kpeter@815
   340
      return *this;
kpeter@815
   341
    }
kpeter@815
   342
kpeter@815
   343
    /// \brief Set single source and target nodes and a supply value.
kpeter@815
   344
    ///
kpeter@815
   345
    /// This function sets a single source node and a single target node
kpeter@815
   346
    /// and the required flow value.
kpeter@815
   347
    /// If neither this function nor \ref supplyMap() is used before
kpeter@815
   348
    /// calling \ref run(), the supply of each node will be set to zero.
kpeter@815
   349
    ///
kpeter@815
   350
    /// Using this function has the same effect as using \ref supplyMap()
kpeter@815
   351
    /// with such a map in which \c k is assigned to \c s, \c -k is
kpeter@815
   352
    /// assigned to \c t and all other nodes have zero supply value.
kpeter@815
   353
    ///
kpeter@815
   354
    /// \param s The source node.
kpeter@815
   355
    /// \param t The target node.
kpeter@815
   356
    /// \param k The required amount of flow from node \c s to node \c t
kpeter@815
   357
    /// (i.e. the supply of \c s and the demand of \c t).
kpeter@815
   358
    ///
kpeter@815
   359
    /// \return <tt>(*this)</tt>
kpeter@815
   360
    CycleCanceling& stSupply(const Node& s, const Node& t, Value k) {
kpeter@815
   361
      for (int i = 0; i != _res_node_num; ++i) {
kpeter@815
   362
        _supply[i] = 0;
kpeter@815
   363
      }
kpeter@815
   364
      _supply[_node_id[s]] =  k;
kpeter@815
   365
      _supply[_node_id[t]] = -k;
kpeter@815
   366
      return *this;
kpeter@815
   367
    }
kpeter@815
   368
    
kpeter@815
   369
    /// @}
kpeter@815
   370
kpeter@814
   371
    /// \name Execution control
kpeter@815
   372
    /// The algorithm can be executed using \ref run().
kpeter@814
   373
kpeter@814
   374
    /// @{
kpeter@814
   375
kpeter@814
   376
    /// \brief Run the algorithm.
kpeter@814
   377
    ///
kpeter@815
   378
    /// This function runs the algorithm.
kpeter@815
   379
    /// The paramters can be specified using functions \ref lowerMap(),
kpeter@815
   380
    /// \ref upperMap(), \ref costMap(), \ref supplyMap(), \ref stSupply().
kpeter@815
   381
    /// For example,
kpeter@815
   382
    /// \code
kpeter@815
   383
    ///   CycleCanceling<ListDigraph> cc(graph);
kpeter@815
   384
    ///   cc.lowerMap(lower).upperMap(upper).costMap(cost)
kpeter@815
   385
    ///     .supplyMap(sup).run();
kpeter@815
   386
    /// \endcode
kpeter@814
   387
    ///
kpeter@830
   388
    /// This function can be called more than once. All the given parameters
kpeter@830
   389
    /// are kept for the next call, unless \ref resetParams() or \ref reset()
kpeter@830
   390
    /// is used, thus only the modified parameters have to be set again.
kpeter@830
   391
    /// If the underlying digraph was also modified after the construction
kpeter@830
   392
    /// of the class (or the last \ref reset() call), then the \ref reset()
kpeter@830
   393
    /// function must be called.
kpeter@814
   394
    ///
kpeter@815
   395
    /// \param method The cycle-canceling method that will be used.
kpeter@815
   396
    /// For more information, see \ref Method.
kpeter@815
   397
    ///
kpeter@815
   398
    /// \return \c INFEASIBLE if no feasible flow exists,
kpeter@815
   399
    /// \n \c OPTIMAL if the problem has optimal solution
kpeter@815
   400
    /// (i.e. it is feasible and bounded), and the algorithm has found
kpeter@815
   401
    /// optimal flow and node potentials (primal and dual solutions),
kpeter@815
   402
    /// \n \c UNBOUNDED if the digraph contains an arc of negative cost
kpeter@815
   403
    /// and infinite upper bound. It means that the objective function
kpeter@815
   404
    /// is unbounded on that arc, however, note that it could actually be
kpeter@815
   405
    /// bounded over the feasible flows, but this algroithm cannot handle
kpeter@815
   406
    /// these cases.
kpeter@815
   407
    ///
kpeter@815
   408
    /// \see ProblemType, Method
kpeter@830
   409
    /// \see resetParams(), reset()
kpeter@815
   410
    ProblemType run(Method method = CANCEL_AND_TIGHTEN) {
kpeter@815
   411
      ProblemType pt = init();
kpeter@815
   412
      if (pt != OPTIMAL) return pt;
kpeter@815
   413
      start(method);
kpeter@815
   414
      return OPTIMAL;
kpeter@815
   415
    }
kpeter@815
   416
kpeter@815
   417
    /// \brief Reset all the parameters that have been given before.
kpeter@815
   418
    ///
kpeter@815
   419
    /// This function resets all the paramaters that have been given
kpeter@815
   420
    /// before using functions \ref lowerMap(), \ref upperMap(),
kpeter@815
   421
    /// \ref costMap(), \ref supplyMap(), \ref stSupply().
kpeter@815
   422
    ///
kpeter@830
   423
    /// It is useful for multiple \ref run() calls. Basically, all the given
kpeter@830
   424
    /// parameters are kept for the next \ref run() call, unless
kpeter@830
   425
    /// \ref resetParams() or \ref reset() is used.
kpeter@830
   426
    /// If the underlying digraph was also modified after the construction
kpeter@830
   427
    /// of the class or the last \ref reset() call, then the \ref reset()
kpeter@830
   428
    /// function must be used, otherwise \ref resetParams() is sufficient.
kpeter@815
   429
    ///
kpeter@815
   430
    /// For example,
kpeter@815
   431
    /// \code
kpeter@815
   432
    ///   CycleCanceling<ListDigraph> cs(graph);
kpeter@815
   433
    ///
kpeter@815
   434
    ///   // First run
kpeter@815
   435
    ///   cc.lowerMap(lower).upperMap(upper).costMap(cost)
kpeter@815
   436
    ///     .supplyMap(sup).run();
kpeter@815
   437
    ///
kpeter@830
   438
    ///   // Run again with modified cost map (resetParams() is not called,
kpeter@815
   439
    ///   // so only the cost map have to be set again)
kpeter@815
   440
    ///   cost[e] += 100;
kpeter@815
   441
    ///   cc.costMap(cost).run();
kpeter@815
   442
    ///
kpeter@830
   443
    ///   // Run again from scratch using resetParams()
kpeter@815
   444
    ///   // (the lower bounds will be set to zero on all arcs)
kpeter@830
   445
    ///   cc.resetParams();
kpeter@815
   446
    ///   cc.upperMap(capacity).costMap(cost)
kpeter@815
   447
    ///     .supplyMap(sup).run();
kpeter@815
   448
    /// \endcode
kpeter@815
   449
    ///
kpeter@815
   450
    /// \return <tt>(*this)</tt>
kpeter@830
   451
    ///
kpeter@830
   452
    /// \see reset(), run()
kpeter@830
   453
    CycleCanceling& resetParams() {
kpeter@815
   454
      for (int i = 0; i != _res_node_num; ++i) {
kpeter@815
   455
        _supply[i] = 0;
kpeter@815
   456
      }
kpeter@815
   457
      int limit = _first_out[_root];
kpeter@815
   458
      for (int j = 0; j != limit; ++j) {
kpeter@815
   459
        _lower[j] = 0;
kpeter@815
   460
        _upper[j] = INF;
kpeter@815
   461
        _cost[j] = _forward[j] ? 1 : -1;
kpeter@815
   462
      }
kpeter@815
   463
      for (int j = limit; j != _res_arc_num; ++j) {
kpeter@815
   464
        _lower[j] = 0;
kpeter@815
   465
        _upper[j] = INF;
kpeter@815
   466
        _cost[j] = 0;
kpeter@815
   467
        _cost[_reverse[j]] = 0;
kpeter@815
   468
      }      
kpeter@815
   469
      _have_lower = false;
kpeter@815
   470
      return *this;
kpeter@814
   471
    }
kpeter@814
   472
kpeter@830
   473
    /// \brief Reset the internal data structures and all the parameters
kpeter@830
   474
    /// that have been given before.
kpeter@830
   475
    ///
kpeter@830
   476
    /// This function resets the internal data structures and all the
kpeter@830
   477
    /// paramaters that have been given before using functions \ref lowerMap(),
kpeter@830
   478
    /// \ref upperMap(), \ref costMap(), \ref supplyMap(), \ref stSupply().
kpeter@830
   479
    ///
kpeter@830
   480
    /// It is useful for multiple \ref run() calls. Basically, all the given
kpeter@830
   481
    /// parameters are kept for the next \ref run() call, unless
kpeter@830
   482
    /// \ref resetParams() or \ref reset() is used.
kpeter@830
   483
    /// If the underlying digraph was also modified after the construction
kpeter@830
   484
    /// of the class or the last \ref reset() call, then the \ref reset()
kpeter@830
   485
    /// function must be used, otherwise \ref resetParams() is sufficient.
kpeter@830
   486
    ///
kpeter@830
   487
    /// See \ref resetParams() for examples.
kpeter@830
   488
    ///
kpeter@830
   489
    /// \return <tt>(*this)</tt>
kpeter@830
   490
    ///
kpeter@830
   491
    /// \see resetParams(), run()
kpeter@830
   492
    CycleCanceling& reset() {
kpeter@830
   493
      // Resize vectors
kpeter@830
   494
      _node_num = countNodes(_graph);
kpeter@830
   495
      _arc_num = countArcs(_graph);
kpeter@830
   496
      _res_node_num = _node_num + 1;
kpeter@830
   497
      _res_arc_num = 2 * (_arc_num + _node_num);
kpeter@830
   498
      _root = _node_num;
kpeter@830
   499
kpeter@830
   500
      _first_out.resize(_res_node_num + 1);
kpeter@830
   501
      _forward.resize(_res_arc_num);
kpeter@830
   502
      _source.resize(_res_arc_num);
kpeter@830
   503
      _target.resize(_res_arc_num);
kpeter@830
   504
      _reverse.resize(_res_arc_num);
kpeter@830
   505
kpeter@830
   506
      _lower.resize(_res_arc_num);
kpeter@830
   507
      _upper.resize(_res_arc_num);
kpeter@830
   508
      _cost.resize(_res_arc_num);
kpeter@830
   509
      _supply.resize(_res_node_num);
kpeter@830
   510
      
kpeter@830
   511
      _res_cap.resize(_res_arc_num);
kpeter@830
   512
      _pi.resize(_res_node_num);
kpeter@830
   513
kpeter@830
   514
      _arc_vec.reserve(_res_arc_num);
kpeter@830
   515
      _cost_vec.reserve(_res_arc_num);
kpeter@830
   516
      _id_vec.reserve(_res_arc_num);
kpeter@830
   517
kpeter@830
   518
      // Copy the graph
kpeter@830
   519
      int i = 0, j = 0, k = 2 * _arc_num + _node_num;
kpeter@830
   520
      for (NodeIt n(_graph); n != INVALID; ++n, ++i) {
kpeter@830
   521
        _node_id[n] = i;
kpeter@830
   522
      }
kpeter@830
   523
      i = 0;
kpeter@830
   524
      for (NodeIt n(_graph); n != INVALID; ++n, ++i) {
kpeter@830
   525
        _first_out[i] = j;
kpeter@830
   526
        for (OutArcIt a(_graph, n); a != INVALID; ++a, ++j) {
kpeter@830
   527
          _arc_idf[a] = j;
kpeter@830
   528
          _forward[j] = true;
kpeter@830
   529
          _source[j] = i;
kpeter@830
   530
          _target[j] = _node_id[_graph.runningNode(a)];
kpeter@830
   531
        }
kpeter@830
   532
        for (InArcIt a(_graph, n); a != INVALID; ++a, ++j) {
kpeter@830
   533
          _arc_idb[a] = j;
kpeter@830
   534
          _forward[j] = false;
kpeter@830
   535
          _source[j] = i;
kpeter@830
   536
          _target[j] = _node_id[_graph.runningNode(a)];
kpeter@830
   537
        }
kpeter@830
   538
        _forward[j] = false;
kpeter@830
   539
        _source[j] = i;
kpeter@830
   540
        _target[j] = _root;
kpeter@830
   541
        _reverse[j] = k;
kpeter@830
   542
        _forward[k] = true;
kpeter@830
   543
        _source[k] = _root;
kpeter@830
   544
        _target[k] = i;
kpeter@830
   545
        _reverse[k] = j;
kpeter@830
   546
        ++j; ++k;
kpeter@830
   547
      }
kpeter@830
   548
      _first_out[i] = j;
kpeter@830
   549
      _first_out[_res_node_num] = k;
kpeter@830
   550
      for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@830
   551
        int fi = _arc_idf[a];
kpeter@830
   552
        int bi = _arc_idb[a];
kpeter@830
   553
        _reverse[fi] = bi;
kpeter@830
   554
        _reverse[bi] = fi;
kpeter@830
   555
      }
kpeter@830
   556
      
kpeter@830
   557
      // Reset parameters
kpeter@830
   558
      resetParams();
kpeter@830
   559
      return *this;
kpeter@830
   560
    }
kpeter@830
   561
kpeter@814
   562
    /// @}
kpeter@814
   563
kpeter@814
   564
    /// \name Query Functions
kpeter@815
   565
    /// The results of the algorithm can be obtained using these
kpeter@814
   566
    /// functions.\n
kpeter@815
   567
    /// The \ref run() function must be called before using them.
kpeter@814
   568
kpeter@814
   569
    /// @{
kpeter@814
   570
kpeter@815
   571
    /// \brief Return the total cost of the found flow.
kpeter@814
   572
    ///
kpeter@815
   573
    /// This function returns the total cost of the found flow.
kpeter@815
   574
    /// Its complexity is O(e).
kpeter@815
   575
    ///
kpeter@815
   576
    /// \note The return type of the function can be specified as a
kpeter@815
   577
    /// template parameter. For example,
kpeter@815
   578
    /// \code
kpeter@815
   579
    ///   cc.totalCost<double>();
kpeter@815
   580
    /// \endcode
kpeter@815
   581
    /// It is useful if the total cost cannot be stored in the \c Cost
kpeter@815
   582
    /// type of the algorithm, which is the default return type of the
kpeter@815
   583
    /// function.
kpeter@814
   584
    ///
kpeter@814
   585
    /// \pre \ref run() must be called before using this function.
kpeter@815
   586
    template <typename Number>
kpeter@815
   587
    Number totalCost() const {
kpeter@815
   588
      Number c = 0;
kpeter@815
   589
      for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   590
        int i = _arc_idb[a];
kpeter@815
   591
        c += static_cast<Number>(_res_cap[i]) *
kpeter@815
   592
             (-static_cast<Number>(_cost[i]));
kpeter@815
   593
      }
kpeter@815
   594
      return c;
kpeter@814
   595
    }
kpeter@814
   596
kpeter@815
   597
#ifndef DOXYGEN
kpeter@815
   598
    Cost totalCost() const {
kpeter@815
   599
      return totalCost<Cost>();
kpeter@814
   600
    }
kpeter@815
   601
#endif
kpeter@814
   602
kpeter@814
   603
    /// \brief Return the flow on the given arc.
kpeter@814
   604
    ///
kpeter@815
   605
    /// This function returns the flow on the given arc.
kpeter@814
   606
    ///
kpeter@814
   607
    /// \pre \ref run() must be called before using this function.
kpeter@815
   608
    Value flow(const Arc& a) const {
kpeter@815
   609
      return _res_cap[_arc_idb[a]];
kpeter@814
   610
    }
kpeter@814
   611
kpeter@815
   612
    /// \brief Return the flow map (the primal solution).
kpeter@814
   613
    ///
kpeter@815
   614
    /// This function copies the flow value on each arc into the given
kpeter@815
   615
    /// map. The \c Value type of the algorithm must be convertible to
kpeter@815
   616
    /// the \c Value type of the map.
kpeter@814
   617
    ///
kpeter@814
   618
    /// \pre \ref run() must be called before using this function.
kpeter@815
   619
    template <typename FlowMap>
kpeter@815
   620
    void flowMap(FlowMap &map) const {
kpeter@815
   621
      for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   622
        map.set(a, _res_cap[_arc_idb[a]]);
kpeter@815
   623
      }
kpeter@814
   624
    }
kpeter@814
   625
kpeter@815
   626
    /// \brief Return the potential (dual value) of the given node.
kpeter@814
   627
    ///
kpeter@815
   628
    /// This function returns the potential (dual value) of the
kpeter@815
   629
    /// given node.
kpeter@814
   630
    ///
kpeter@814
   631
    /// \pre \ref run() must be called before using this function.
kpeter@815
   632
    Cost potential(const Node& n) const {
kpeter@815
   633
      return static_cast<Cost>(_pi[_node_id[n]]);
kpeter@815
   634
    }
kpeter@815
   635
kpeter@815
   636
    /// \brief Return the potential map (the dual solution).
kpeter@815
   637
    ///
kpeter@815
   638
    /// This function copies the potential (dual value) of each node
kpeter@815
   639
    /// into the given map.
kpeter@815
   640
    /// The \c Cost type of the algorithm must be convertible to the
kpeter@815
   641
    /// \c Value type of the map.
kpeter@815
   642
    ///
kpeter@815
   643
    /// \pre \ref run() must be called before using this function.
kpeter@815
   644
    template <typename PotentialMap>
kpeter@815
   645
    void potentialMap(PotentialMap &map) const {
kpeter@815
   646
      for (NodeIt n(_graph); n != INVALID; ++n) {
kpeter@815
   647
        map.set(n, static_cast<Cost>(_pi[_node_id[n]]));
kpeter@815
   648
      }
kpeter@814
   649
    }
kpeter@814
   650
kpeter@814
   651
    /// @}
kpeter@814
   652
kpeter@814
   653
  private:
kpeter@814
   654
kpeter@815
   655
    // Initialize the algorithm
kpeter@815
   656
    ProblemType init() {
kpeter@815
   657
      if (_res_node_num <= 1) return INFEASIBLE;
kpeter@814
   658
kpeter@815
   659
      // Check the sum of supply values
kpeter@815
   660
      _sum_supply = 0;
kpeter@815
   661
      for (int i = 0; i != _root; ++i) {
kpeter@815
   662
        _sum_supply += _supply[i];
kpeter@814
   663
      }
kpeter@815
   664
      if (_sum_supply > 0) return INFEASIBLE;
kpeter@815
   665
      
kpeter@815
   666
kpeter@815
   667
      // Initialize vectors
kpeter@815
   668
      for (int i = 0; i != _res_node_num; ++i) {
kpeter@815
   669
        _pi[i] = 0;
kpeter@815
   670
      }
kpeter@815
   671
      ValueVector excess(_supply);
kpeter@815
   672
      
kpeter@815
   673
      // Remove infinite upper bounds and check negative arcs
kpeter@815
   674
      const Value MAX = std::numeric_limits<Value>::max();
kpeter@815
   675
      int last_out;
kpeter@815
   676
      if (_have_lower) {
kpeter@815
   677
        for (int i = 0; i != _root; ++i) {
kpeter@815
   678
          last_out = _first_out[i+1];
kpeter@815
   679
          for (int j = _first_out[i]; j != last_out; ++j) {
kpeter@815
   680
            if (_forward[j]) {
kpeter@815
   681
              Value c = _cost[j] < 0 ? _upper[j] : _lower[j];
kpeter@815
   682
              if (c >= MAX) return UNBOUNDED;
kpeter@815
   683
              excess[i] -= c;
kpeter@815
   684
              excess[_target[j]] += c;
kpeter@815
   685
            }
kpeter@815
   686
          }
kpeter@815
   687
        }
kpeter@815
   688
      } else {
kpeter@815
   689
        for (int i = 0; i != _root; ++i) {
kpeter@815
   690
          last_out = _first_out[i+1];
kpeter@815
   691
          for (int j = _first_out[i]; j != last_out; ++j) {
kpeter@815
   692
            if (_forward[j] && _cost[j] < 0) {
kpeter@815
   693
              Value c = _upper[j];
kpeter@815
   694
              if (c >= MAX) return UNBOUNDED;
kpeter@815
   695
              excess[i] -= c;
kpeter@815
   696
              excess[_target[j]] += c;
kpeter@815
   697
            }
kpeter@815
   698
          }
kpeter@815
   699
        }
kpeter@815
   700
      }
kpeter@815
   701
      Value ex, max_cap = 0;
kpeter@815
   702
      for (int i = 0; i != _res_node_num; ++i) {
kpeter@815
   703
        ex = excess[i];
kpeter@815
   704
        if (ex < 0) max_cap -= ex;
kpeter@815
   705
      }
kpeter@815
   706
      for (int j = 0; j != _res_arc_num; ++j) {
kpeter@815
   707
        if (_upper[j] >= MAX) _upper[j] = max_cap;
kpeter@814
   708
      }
kpeter@814
   709
kpeter@815
   710
      // Initialize maps for Circulation and remove non-zero lower bounds
kpeter@815
   711
      ConstMap<Arc, Value> low(0);
kpeter@815
   712
      typedef typename Digraph::template ArcMap<Value> ValueArcMap;
kpeter@815
   713
      typedef typename Digraph::template NodeMap<Value> ValueNodeMap;
kpeter@815
   714
      ValueArcMap cap(_graph), flow(_graph);
kpeter@815
   715
      ValueNodeMap sup(_graph);
kpeter@815
   716
      for (NodeIt n(_graph); n != INVALID; ++n) {
kpeter@815
   717
        sup[n] = _supply[_node_id[n]];
kpeter@815
   718
      }
kpeter@815
   719
      if (_have_lower) {
kpeter@815
   720
        for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   721
          int j = _arc_idf[a];
kpeter@815
   722
          Value c = _lower[j];
kpeter@815
   723
          cap[a] = _upper[j] - c;
kpeter@815
   724
          sup[_graph.source(a)] -= c;
kpeter@815
   725
          sup[_graph.target(a)] += c;
kpeter@815
   726
        }
kpeter@815
   727
      } else {
kpeter@815
   728
        for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   729
          cap[a] = _upper[_arc_idf[a]];
kpeter@815
   730
        }
kpeter@815
   731
      }
kpeter@814
   732
kpeter@815
   733
      // Find a feasible flow using Circulation
kpeter@815
   734
      Circulation<Digraph, ConstMap<Arc, Value>, ValueArcMap, ValueNodeMap>
kpeter@815
   735
        circ(_graph, low, cap, sup);
kpeter@815
   736
      if (!circ.flowMap(flow).run()) return INFEASIBLE;
kpeter@815
   737
kpeter@815
   738
      // Set residual capacities and handle GEQ supply type
kpeter@815
   739
      if (_sum_supply < 0) {
kpeter@815
   740
        for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   741
          Value fa = flow[a];
kpeter@815
   742
          _res_cap[_arc_idf[a]] = cap[a] - fa;
kpeter@815
   743
          _res_cap[_arc_idb[a]] = fa;
kpeter@815
   744
          sup[_graph.source(a)] -= fa;
kpeter@815
   745
          sup[_graph.target(a)] += fa;
kpeter@815
   746
        }
kpeter@815
   747
        for (NodeIt n(_graph); n != INVALID; ++n) {
kpeter@815
   748
          excess[_node_id[n]] = sup[n];
kpeter@815
   749
        }
kpeter@815
   750
        for (int a = _first_out[_root]; a != _res_arc_num; ++a) {
kpeter@815
   751
          int u = _target[a];
kpeter@815
   752
          int ra = _reverse[a];
kpeter@815
   753
          _res_cap[a] = -_sum_supply + 1;
kpeter@815
   754
          _res_cap[ra] = -excess[u];
kpeter@815
   755
          _cost[a] = 0;
kpeter@815
   756
          _cost[ra] = 0;
kpeter@815
   757
        }
kpeter@815
   758
      } else {
kpeter@815
   759
        for (ArcIt a(_graph); a != INVALID; ++a) {
kpeter@815
   760
          Value fa = flow[a];
kpeter@815
   761
          _res_cap[_arc_idf[a]] = cap[a] - fa;
kpeter@815
   762
          _res_cap[_arc_idb[a]] = fa;
kpeter@815
   763
        }
kpeter@815
   764
        for (int a = _first_out[_root]; a != _res_arc_num; ++a) {
kpeter@815
   765
          int ra = _reverse[a];
kpeter@815
   766
          _res_cap[a] = 1;
kpeter@815
   767
          _res_cap[ra] = 0;
kpeter@815
   768
          _cost[a] = 0;
kpeter@815
   769
          _cost[ra] = 0;
kpeter@815
   770
        }
kpeter@815
   771
      }
kpeter@815
   772
      
kpeter@815
   773
      return OPTIMAL;
kpeter@815
   774
    }
kpeter@815
   775
    
kpeter@815
   776
    // Build a StaticDigraph structure containing the current
kpeter@815
   777
    // residual network
kpeter@815
   778
    void buildResidualNetwork() {
kpeter@815
   779
      _arc_vec.clear();
kpeter@815
   780
      _cost_vec.clear();
kpeter@815
   781
      _id_vec.clear();
kpeter@815
   782
      for (int j = 0; j != _res_arc_num; ++j) {
kpeter@815
   783
        if (_res_cap[j] > 0) {
kpeter@815
   784
          _arc_vec.push_back(IntPair(_source[j], _target[j]));
kpeter@815
   785
          _cost_vec.push_back(_cost[j]);
kpeter@815
   786
          _id_vec.push_back(j);
kpeter@815
   787
        }
kpeter@815
   788
      }
kpeter@815
   789
      _sgr.build(_res_node_num, _arc_vec.begin(), _arc_vec.end());
kpeter@814
   790
    }
kpeter@814
   791
kpeter@815
   792
    // Execute the algorithm and transform the results
kpeter@815
   793
    void start(Method method) {
kpeter@815
   794
      // Execute the algorithm
kpeter@815
   795
      switch (method) {
kpeter@815
   796
        case SIMPLE_CYCLE_CANCELING:
kpeter@815
   797
          startSimpleCycleCanceling();
kpeter@815
   798
          break;
kpeter@815
   799
        case MINIMUM_MEAN_CYCLE_CANCELING:
kpeter@815
   800
          startMinMeanCycleCanceling();
kpeter@815
   801
          break;
kpeter@815
   802
        case CANCEL_AND_TIGHTEN:
kpeter@815
   803
          startCancelAndTighten();
kpeter@815
   804
          break;
kpeter@815
   805
      }
kpeter@814
   806
kpeter@815
   807
      // Compute node potentials
kpeter@815
   808
      if (method != SIMPLE_CYCLE_CANCELING) {
kpeter@815
   809
        buildResidualNetwork();
kpeter@815
   810
        typename BellmanFord<StaticDigraph, CostArcMap>
kpeter@815
   811
          ::template SetDistMap<CostNodeMap>::Create bf(_sgr, _cost_map);
kpeter@815
   812
        bf.distMap(_pi_map);
kpeter@815
   813
        bf.init(0);
kpeter@815
   814
        bf.start();
kpeter@814
   815
      }
kpeter@815
   816
kpeter@815
   817
      // Handle non-zero lower bounds
kpeter@815
   818
      if (_have_lower) {
kpeter@815
   819
        int limit = _first_out[_root];
kpeter@815
   820
        for (int j = 0; j != limit; ++j) {
kpeter@815
   821
          if (!_forward[j]) _res_cap[j] += _lower[j];
kpeter@815
   822
        }
kpeter@815
   823
      }
kpeter@814
   824
    }
kpeter@814
   825
kpeter@815
   826
    // Execute the "Simple Cycle Canceling" method
kpeter@815
   827
    void startSimpleCycleCanceling() {
kpeter@815
   828
      // Constants for computing the iteration limits
kpeter@815
   829
      const int BF_FIRST_LIMIT  = 2;
kpeter@815
   830
      const double BF_LIMIT_FACTOR = 1.5;
kpeter@815
   831
      
kpeter@820
   832
      typedef StaticVectorMap<StaticDigraph::Arc, Value> FilterMap;
kpeter@815
   833
      typedef FilterArcs<StaticDigraph, FilterMap> ResDigraph;
kpeter@820
   834
      typedef StaticVectorMap<StaticDigraph::Node, StaticDigraph::Arc> PredMap;
kpeter@815
   835
      typedef typename BellmanFord<ResDigraph, CostArcMap>
kpeter@815
   836
        ::template SetDistMap<CostNodeMap>
kpeter@815
   837
        ::template SetPredMap<PredMap>::Create BF;
kpeter@815
   838
      
kpeter@815
   839
      // Build the residual network
kpeter@815
   840
      _arc_vec.clear();
kpeter@815
   841
      _cost_vec.clear();
kpeter@815
   842
      for (int j = 0; j != _res_arc_num; ++j) {
kpeter@815
   843
        _arc_vec.push_back(IntPair(_source[j], _target[j]));
kpeter@815
   844
        _cost_vec.push_back(_cost[j]);
kpeter@815
   845
      }
kpeter@815
   846
      _sgr.build(_res_node_num, _arc_vec.begin(), _arc_vec.end());
kpeter@815
   847
kpeter@815
   848
      FilterMap filter_map(_res_cap);
kpeter@815
   849
      ResDigraph rgr(_sgr, filter_map);
kpeter@815
   850
      std::vector<int> cycle;
kpeter@815
   851
      std::vector<StaticDigraph::Arc> pred(_res_arc_num);
kpeter@815
   852
      PredMap pred_map(pred);
kpeter@815
   853
      BF bf(rgr, _cost_map);
kpeter@815
   854
      bf.distMap(_pi_map).predMap(pred_map);
kpeter@814
   855
kpeter@814
   856
      int length_bound = BF_FIRST_LIMIT;
kpeter@814
   857
      bool optimal = false;
kpeter@814
   858
      while (!optimal) {
kpeter@814
   859
        bf.init(0);
kpeter@814
   860
        int iter_num = 0;
kpeter@814
   861
        bool cycle_found = false;
kpeter@814
   862
        while (!cycle_found) {
kpeter@815
   863
          // Perform some iterations of the Bellman-Ford algorithm
kpeter@815
   864
          int curr_iter_num = iter_num + length_bound <= _node_num ?
kpeter@815
   865
            length_bound : _node_num - iter_num;
kpeter@814
   866
          iter_num += curr_iter_num;
kpeter@814
   867
          int real_iter_num = curr_iter_num;
kpeter@814
   868
          for (int i = 0; i < curr_iter_num; ++i) {
kpeter@814
   869
            if (bf.processNextWeakRound()) {
kpeter@814
   870
              real_iter_num = i;
kpeter@814
   871
              break;
kpeter@814
   872
            }
kpeter@814
   873
          }
kpeter@814
   874
          if (real_iter_num < curr_iter_num) {
kpeter@814
   875
            // Optimal flow is found
kpeter@814
   876
            optimal = true;
kpeter@814
   877
            break;
kpeter@814
   878
          } else {
kpeter@815
   879
            // Search for node disjoint negative cycles
kpeter@815
   880
            std::vector<int> state(_res_node_num, 0);
kpeter@814
   881
            int id = 0;
kpeter@815
   882
            for (int u = 0; u != _res_node_num; ++u) {
kpeter@815
   883
              if (state[u] != 0) continue;
kpeter@815
   884
              ++id;
kpeter@815
   885
              int v = u;
kpeter@815
   886
              for (; v != -1 && state[v] == 0; v = pred[v] == INVALID ?
kpeter@815
   887
                   -1 : rgr.id(rgr.source(pred[v]))) {
kpeter@815
   888
                state[v] = id;
kpeter@814
   889
              }
kpeter@815
   890
              if (v != -1 && state[v] == id) {
kpeter@815
   891
                // A negative cycle is found
kpeter@814
   892
                cycle_found = true;
kpeter@814
   893
                cycle.clear();
kpeter@815
   894
                StaticDigraph::Arc a = pred[v];
kpeter@815
   895
                Value d, delta = _res_cap[rgr.id(a)];
kpeter@815
   896
                cycle.push_back(rgr.id(a));
kpeter@815
   897
                while (rgr.id(rgr.source(a)) != v) {
kpeter@815
   898
                  a = pred_map[rgr.source(a)];
kpeter@815
   899
                  d = _res_cap[rgr.id(a)];
kpeter@815
   900
                  if (d < delta) delta = d;
kpeter@815
   901
                  cycle.push_back(rgr.id(a));
kpeter@814
   902
                }
kpeter@814
   903
kpeter@815
   904
                // Augment along the cycle
kpeter@815
   905
                for (int i = 0; i < int(cycle.size()); ++i) {
kpeter@815
   906
                  int j = cycle[i];
kpeter@815
   907
                  _res_cap[j] -= delta;
kpeter@815
   908
                  _res_cap[_reverse[j]] += delta;
kpeter@815
   909
                }
kpeter@814
   910
              }
kpeter@814
   911
            }
kpeter@814
   912
          }
kpeter@814
   913
kpeter@815
   914
          // Increase iteration limit if no cycle is found
kpeter@815
   915
          if (!cycle_found) {
kpeter@815
   916
            length_bound = static_cast<int>(length_bound * BF_LIMIT_FACTOR);
kpeter@815
   917
          }
kpeter@814
   918
        }
kpeter@814
   919
      }
kpeter@814
   920
    }
kpeter@814
   921
kpeter@815
   922
    // Execute the "Minimum Mean Cycle Canceling" method
kpeter@815
   923
    void startMinMeanCycleCanceling() {
kpeter@815
   924
      typedef SimplePath<StaticDigraph> SPath;
kpeter@815
   925
      typedef typename SPath::ArcIt SPathArcIt;
kpeter@815
   926
      typedef typename Howard<StaticDigraph, CostArcMap>
kpeter@815
   927
        ::template SetPath<SPath>::Create MMC;
kpeter@815
   928
      
kpeter@815
   929
      SPath cycle;
kpeter@815
   930
      MMC mmc(_sgr, _cost_map);
kpeter@815
   931
      mmc.cycle(cycle);
kpeter@815
   932
      buildResidualNetwork();
kpeter@815
   933
      while (mmc.findMinMean() && mmc.cycleLength() < 0) {
kpeter@815
   934
        // Find the cycle
kpeter@815
   935
        mmc.findCycle();
kpeter@814
   936
kpeter@815
   937
        // Compute delta value
kpeter@815
   938
        Value delta = INF;
kpeter@815
   939
        for (SPathArcIt a(cycle); a != INVALID; ++a) {
kpeter@815
   940
          Value d = _res_cap[_id_vec[_sgr.id(a)]];
kpeter@815
   941
          if (d < delta) delta = d;
kpeter@815
   942
        }
kpeter@814
   943
kpeter@815
   944
        // Augment along the cycle
kpeter@815
   945
        for (SPathArcIt a(cycle); a != INVALID; ++a) {
kpeter@815
   946
          int j = _id_vec[_sgr.id(a)];
kpeter@815
   947
          _res_cap[j] -= delta;
kpeter@815
   948
          _res_cap[_reverse[j]] += delta;
kpeter@815
   949
        }
kpeter@815
   950
kpeter@815
   951
        // Rebuild the residual network        
kpeter@815
   952
        buildResidualNetwork();
kpeter@815
   953
      }
kpeter@815
   954
    }
kpeter@815
   955
kpeter@815
   956
    // Execute the "Cancel And Tighten" method
kpeter@815
   957
    void startCancelAndTighten() {
kpeter@815
   958
      // Constants for the min mean cycle computations
kpeter@815
   959
      const double LIMIT_FACTOR = 1.0;
kpeter@815
   960
      const int MIN_LIMIT = 5;
kpeter@815
   961
kpeter@815
   962
      // Contruct auxiliary data vectors
kpeter@815
   963
      DoubleVector pi(_res_node_num, 0.0);
kpeter@815
   964
      IntVector level(_res_node_num);
kpeter@815
   965
      CharVector reached(_res_node_num);
kpeter@815
   966
      CharVector processed(_res_node_num);
kpeter@815
   967
      IntVector pred_node(_res_node_num);
kpeter@815
   968
      IntVector pred_arc(_res_node_num);
kpeter@815
   969
      std::vector<int> stack(_res_node_num);
kpeter@815
   970
      std::vector<int> proc_vector(_res_node_num);
kpeter@815
   971
kpeter@815
   972
      // Initialize epsilon
kpeter@815
   973
      double epsilon = 0;
kpeter@815
   974
      for (int a = 0; a != _res_arc_num; ++a) {
kpeter@815
   975
        if (_res_cap[a] > 0 && -_cost[a] > epsilon)
kpeter@815
   976
          epsilon = -_cost[a];
kpeter@815
   977
      }
kpeter@815
   978
kpeter@815
   979
      // Start phases
kpeter@815
   980
      Tolerance<double> tol;
kpeter@815
   981
      tol.epsilon(1e-6);
kpeter@815
   982
      int limit = int(LIMIT_FACTOR * std::sqrt(double(_res_node_num)));
kpeter@815
   983
      if (limit < MIN_LIMIT) limit = MIN_LIMIT;
kpeter@815
   984
      int iter = limit;
kpeter@815
   985
      while (epsilon * _res_node_num >= 1) {
kpeter@815
   986
        // Find and cancel cycles in the admissible network using DFS
kpeter@815
   987
        for (int u = 0; u != _res_node_num; ++u) {
kpeter@815
   988
          reached[u] = false;
kpeter@815
   989
          processed[u] = false;
kpeter@815
   990
        }
kpeter@815
   991
        int stack_head = -1;
kpeter@815
   992
        int proc_head = -1;
kpeter@815
   993
        for (int start = 0; start != _res_node_num; ++start) {
kpeter@815
   994
          if (reached[start]) continue;
kpeter@815
   995
kpeter@815
   996
          // New start node
kpeter@815
   997
          reached[start] = true;
kpeter@815
   998
          pred_arc[start] = -1;
kpeter@815
   999
          pred_node[start] = -1;
kpeter@815
  1000
kpeter@815
  1001
          // Find the first admissible outgoing arc
kpeter@815
  1002
          double p = pi[start];
kpeter@815
  1003
          int a = _first_out[start];
kpeter@815
  1004
          int last_out = _first_out[start+1];
kpeter@815
  1005
          for (; a != last_out && (_res_cap[a] == 0 ||
kpeter@815
  1006
               !tol.negative(_cost[a] + p - pi[_target[a]])); ++a) ;
kpeter@815
  1007
          if (a == last_out) {
kpeter@815
  1008
            processed[start] = true;
kpeter@815
  1009
            proc_vector[++proc_head] = start;
kpeter@815
  1010
            continue;
kpeter@815
  1011
          }
kpeter@815
  1012
          stack[++stack_head] = a;
kpeter@815
  1013
kpeter@815
  1014
          while (stack_head >= 0) {
kpeter@815
  1015
            int sa = stack[stack_head];
kpeter@815
  1016
            int u = _source[sa];
kpeter@815
  1017
            int v = _target[sa];
kpeter@815
  1018
kpeter@815
  1019
            if (!reached[v]) {
kpeter@815
  1020
              // A new node is reached
kpeter@815
  1021
              reached[v] = true;
kpeter@815
  1022
              pred_node[v] = u;
kpeter@815
  1023
              pred_arc[v] = sa;
kpeter@815
  1024
              p = pi[v];
kpeter@815
  1025
              a = _first_out[v];
kpeter@815
  1026
              last_out = _first_out[v+1];
kpeter@815
  1027
              for (; a != last_out && (_res_cap[a] == 0 ||
kpeter@815
  1028
                   !tol.negative(_cost[a] + p - pi[_target[a]])); ++a) ;
kpeter@815
  1029
              stack[++stack_head] = a == last_out ? -1 : a;
kpeter@815
  1030
            } else {
kpeter@815
  1031
              if (!processed[v]) {
kpeter@815
  1032
                // A cycle is found
kpeter@815
  1033
                int n, w = u;
kpeter@815
  1034
                Value d, delta = _res_cap[sa];
kpeter@815
  1035
                for (n = u; n != v; n = pred_node[n]) {
kpeter@815
  1036
                  d = _res_cap[pred_arc[n]];
kpeter@815
  1037
                  if (d <= delta) {
kpeter@815
  1038
                    delta = d;
kpeter@815
  1039
                    w = pred_node[n];
kpeter@815
  1040
                  }
kpeter@815
  1041
                }
kpeter@815
  1042
kpeter@815
  1043
                // Augment along the cycle
kpeter@815
  1044
                _res_cap[sa] -= delta;
kpeter@815
  1045
                _res_cap[_reverse[sa]] += delta;
kpeter@815
  1046
                for (n = u; n != v; n = pred_node[n]) {
kpeter@815
  1047
                  int pa = pred_arc[n];
kpeter@815
  1048
                  _res_cap[pa] -= delta;
kpeter@815
  1049
                  _res_cap[_reverse[pa]] += delta;
kpeter@815
  1050
                }
kpeter@815
  1051
                for (n = u; stack_head > 0 && n != w; n = pred_node[n]) {
kpeter@815
  1052
                  --stack_head;
kpeter@815
  1053
                  reached[n] = false;
kpeter@815
  1054
                }
kpeter@815
  1055
                u = w;
kpeter@815
  1056
              }
kpeter@815
  1057
              v = u;
kpeter@815
  1058
kpeter@815
  1059
              // Find the next admissible outgoing arc
kpeter@815
  1060
              p = pi[v];
kpeter@815
  1061
              a = stack[stack_head] + 1;
kpeter@815
  1062
              last_out = _first_out[v+1];
kpeter@815
  1063
              for (; a != last_out && (_res_cap[a] == 0 ||
kpeter@815
  1064
                   !tol.negative(_cost[a] + p - pi[_target[a]])); ++a) ;
kpeter@815
  1065
              stack[stack_head] = a == last_out ? -1 : a;
kpeter@815
  1066
            }
kpeter@815
  1067
kpeter@815
  1068
            while (stack_head >= 0 && stack[stack_head] == -1) {
kpeter@815
  1069
              processed[v] = true;
kpeter@815
  1070
              proc_vector[++proc_head] = v;
kpeter@815
  1071
              if (--stack_head >= 0) {
kpeter@815
  1072
                // Find the next admissible outgoing arc
kpeter@815
  1073
                v = _source[stack[stack_head]];
kpeter@815
  1074
                p = pi[v];
kpeter@815
  1075
                a = stack[stack_head] + 1;
kpeter@815
  1076
                last_out = _first_out[v+1];
kpeter@815
  1077
                for (; a != last_out && (_res_cap[a] == 0 ||
kpeter@815
  1078
                     !tol.negative(_cost[a] + p - pi[_target[a]])); ++a) ;
kpeter@815
  1079
                stack[stack_head] = a == last_out ? -1 : a;
kpeter@815
  1080
              }
kpeter@815
  1081
            }
kpeter@815
  1082
          }
kpeter@815
  1083
        }
kpeter@815
  1084
kpeter@815
  1085
        // Tighten potentials and epsilon
kpeter@815
  1086
        if (--iter > 0) {
kpeter@815
  1087
          for (int u = 0; u != _res_node_num; ++u) {
kpeter@815
  1088
            level[u] = 0;
kpeter@815
  1089
          }
kpeter@815
  1090
          for (int i = proc_head; i > 0; --i) {
kpeter@815
  1091
            int u = proc_vector[i];
kpeter@815
  1092
            double p = pi[u];
kpeter@815
  1093
            int l = level[u] + 1;
kpeter@815
  1094
            int last_out = _first_out[u+1];
kpeter@815
  1095
            for (int a = _first_out[u]; a != last_out; ++a) {
kpeter@815
  1096
              int v = _target[a];
kpeter@815
  1097
              if (_res_cap[a] > 0 && tol.negative(_cost[a] + p - pi[v]) &&
kpeter@815
  1098
                  l > level[v]) level[v] = l;
kpeter@815
  1099
            }
kpeter@814
  1100
          }
kpeter@814
  1101
kpeter@815
  1102
          // Modify potentials
kpeter@815
  1103
          double q = std::numeric_limits<double>::max();
kpeter@815
  1104
          for (int u = 0; u != _res_node_num; ++u) {
kpeter@815
  1105
            int lu = level[u];
kpeter@815
  1106
            double p, pu = pi[u];
kpeter@815
  1107
            int last_out = _first_out[u+1];
kpeter@815
  1108
            for (int a = _first_out[u]; a != last_out; ++a) {
kpeter@815
  1109
              if (_res_cap[a] == 0) continue;
kpeter@815
  1110
              int v = _target[a];
kpeter@815
  1111
              int ld = lu - level[v];
kpeter@815
  1112
              if (ld > 0) {
kpeter@815
  1113
                p = (_cost[a] + pu - pi[v] + epsilon) / (ld + 1);
kpeter@815
  1114
                if (p < q) q = p;
kpeter@815
  1115
              }
kpeter@815
  1116
            }
kpeter@815
  1117
          }
kpeter@815
  1118
          for (int u = 0; u != _res_node_num; ++u) {
kpeter@815
  1119
            pi[u] -= q * level[u];
kpeter@815
  1120
          }
kpeter@814
  1121
kpeter@815
  1122
          // Modify epsilon
kpeter@815
  1123
          epsilon = 0;
kpeter@815
  1124
          for (int u = 0; u != _res_node_num; ++u) {
kpeter@815
  1125
            double curr, pu = pi[u];
kpeter@815
  1126
            int last_out = _first_out[u+1];
kpeter@815
  1127
            for (int a = _first_out[u]; a != last_out; ++a) {
kpeter@815
  1128
              if (_res_cap[a] == 0) continue;
kpeter@815
  1129
              curr = _cost[a] + pu - pi[_target[a]];
kpeter@815
  1130
              if (-curr > epsilon) epsilon = -curr;
kpeter@815
  1131
            }
kpeter@815
  1132
          }
kpeter@815
  1133
        } else {
kpeter@815
  1134
          typedef Howard<StaticDigraph, CostArcMap> MMC;
kpeter@815
  1135
          typedef typename BellmanFord<StaticDigraph, CostArcMap>
kpeter@815
  1136
            ::template SetDistMap<CostNodeMap>::Create BF;
kpeter@815
  1137
kpeter@815
  1138
          // Set epsilon to the minimum cycle mean
kpeter@815
  1139
          buildResidualNetwork();
kpeter@815
  1140
          MMC mmc(_sgr, _cost_map);
kpeter@815
  1141
          mmc.findMinMean();
kpeter@815
  1142
          epsilon = -mmc.cycleMean();
kpeter@815
  1143
          Cost cycle_cost = mmc.cycleLength();
kpeter@815
  1144
          int cycle_size = mmc.cycleArcNum();
kpeter@815
  1145
          
kpeter@815
  1146
          // Compute feasible potentials for the current epsilon
kpeter@815
  1147
          for (int i = 0; i != int(_cost_vec.size()); ++i) {
kpeter@815
  1148
            _cost_vec[i] = cycle_size * _cost_vec[i] - cycle_cost;
kpeter@815
  1149
          }
kpeter@815
  1150
          BF bf(_sgr, _cost_map);
kpeter@815
  1151
          bf.distMap(_pi_map);
kpeter@815
  1152
          bf.init(0);
kpeter@815
  1153
          bf.start();
kpeter@815
  1154
          for (int u = 0; u != _res_node_num; ++u) {
kpeter@815
  1155
            pi[u] = static_cast<double>(_pi[u]) / cycle_size;
kpeter@815
  1156
          }
kpeter@815
  1157
        
kpeter@815
  1158
          iter = limit;
kpeter@814
  1159
        }
kpeter@814
  1160
      }
kpeter@814
  1161
    }
kpeter@814
  1162
kpeter@814
  1163
  }; //class CycleCanceling
kpeter@814
  1164
kpeter@814
  1165
  ///@}
kpeter@814
  1166
kpeter@814
  1167
} //namespace lemon
kpeter@814
  1168
kpeter@814
  1169
#endif //LEMON_CYCLE_CANCELING_H