lemon/preflow.h
author Peter Kovacs <kpeter@inf.elte.hu>
Mon, 28 Sep 2009 15:53:20 +0200
changeset 781 6f10c6ec5a21
parent 713 4ac30454f1c1
parent 689 86c49553fea5
child 755 134852d7fb0a
child 786 e20173729589
permissions -rw-r--r--
Small fixes related to BellmanFord (#51)

- Add a missing #include.
- Add a missing const keyword for negativeCycle().
- Test if negativeCycle() is const function.
alpar@389
     1
/* -*- mode: C++; indent-tabs-mode: nil; -*-
alpar@389
     2
 *
alpar@389
     3
 * This file is a part of LEMON, a generic C++ optimization library.
alpar@389
     4
 *
alpar@440
     5
 * Copyright (C) 2003-2009
alpar@389
     6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@389
     7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@389
     8
 *
alpar@389
     9
 * Permission to use, modify and distribute this software is granted
alpar@389
    10
 * provided that this copyright notice appears in all copies. For
alpar@389
    11
 * precise terms see the accompanying LICENSE file.
alpar@389
    12
 *
alpar@389
    13
 * This software is provided "AS IS" with no warranty of any kind,
alpar@389
    14
 * express or implied, and with no claim as to its suitability for any
alpar@389
    15
 * purpose.
alpar@389
    16
 *
alpar@389
    17
 */
alpar@389
    18
alpar@389
    19
#ifndef LEMON_PREFLOW_H
alpar@389
    20
#define LEMON_PREFLOW_H
alpar@389
    21
alpar@389
    22
#include <lemon/tolerance.h>
alpar@389
    23
#include <lemon/elevator.h>
alpar@389
    24
alpar@389
    25
/// \file
alpar@389
    26
/// \ingroup max_flow
alpar@389
    27
/// \brief Implementation of the preflow algorithm.
alpar@389
    28
alpar@389
    29
namespace lemon {
alpar@389
    30
alpar@389
    31
  /// \brief Default traits class of Preflow class.
alpar@389
    32
  ///
alpar@389
    33
  /// Default traits class of Preflow class.
kpeter@503
    34
  /// \tparam GR Digraph type.
kpeter@559
    35
  /// \tparam CAP Capacity map type.
kpeter@559
    36
  template <typename GR, typename CAP>
alpar@389
    37
  struct PreflowDefaultTraits {
alpar@389
    38
kpeter@393
    39
    /// \brief The type of the digraph the algorithm runs on.
kpeter@503
    40
    typedef GR Digraph;
alpar@389
    41
alpar@389
    42
    /// \brief The type of the map that stores the arc capacities.
alpar@389
    43
    ///
alpar@389
    44
    /// The type of the map that stores the arc capacities.
alpar@389
    45
    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
kpeter@559
    46
    typedef CAP CapacityMap;
alpar@389
    47
kpeter@393
    48
    /// \brief The type of the flow values.
kpeter@641
    49
    typedef typename CapacityMap::Value Value;
alpar@389
    50
kpeter@393
    51
    /// \brief The type of the map that stores the flow values.
alpar@389
    52
    ///
kpeter@393
    53
    /// The type of the map that stores the flow values.
alpar@389
    54
    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
kpeter@713
    55
#ifdef DOXYGEN
kpeter@713
    56
    typedef GR::ArcMap<Value> FlowMap;
kpeter@713
    57
#else
kpeter@641
    58
    typedef typename Digraph::template ArcMap<Value> FlowMap;
kpeter@713
    59
#endif
alpar@389
    60
alpar@389
    61
    /// \brief Instantiates a FlowMap.
alpar@389
    62
    ///
alpar@389
    63
    /// This function instantiates a \ref FlowMap.
kpeter@610
    64
    /// \param digraph The digraph for which we would like to define
alpar@389
    65
    /// the flow map.
alpar@389
    66
    static FlowMap* createFlowMap(const Digraph& digraph) {
alpar@389
    67
      return new FlowMap(digraph);
alpar@389
    68
    }
alpar@389
    69
kpeter@393
    70
    /// \brief The elevator type used by Preflow algorithm.
alpar@389
    71
    ///
alpar@389
    72
    /// The elevator type used by Preflow algorithm.
alpar@389
    73
    ///
kpeter@713
    74
    /// \sa Elevator, LinkedElevator
kpeter@713
    75
#ifdef DOXYGEN
kpeter@713
    76
    typedef lemon::Elevator<GR, GR::Node> Elevator;
kpeter@713
    77
#else
kpeter@713
    78
    typedef lemon::Elevator<Digraph, typename Digraph::Node> Elevator;
kpeter@713
    79
#endif
alpar@389
    80
alpar@389
    81
    /// \brief Instantiates an Elevator.
alpar@389
    82
    ///
kpeter@393
    83
    /// This function instantiates an \ref Elevator.
kpeter@610
    84
    /// \param digraph The digraph for which we would like to define
alpar@389
    85
    /// the elevator.
alpar@389
    86
    /// \param max_level The maximum level of the elevator.
alpar@389
    87
    static Elevator* createElevator(const Digraph& digraph, int max_level) {
alpar@389
    88
      return new Elevator(digraph, max_level);
alpar@389
    89
    }
alpar@389
    90
alpar@389
    91
    /// \brief The tolerance used by the algorithm
alpar@389
    92
    ///
alpar@389
    93
    /// The tolerance used by the algorithm to handle inexact computation.
kpeter@641
    94
    typedef lemon::Tolerance<Value> Tolerance;
alpar@389
    95
alpar@389
    96
  };
alpar@389
    97
alpar@389
    98
alpar@389
    99
  /// \ingroup max_flow
alpar@389
   100
  ///
kpeter@393
   101
  /// \brief %Preflow algorithm class.
alpar@389
   102
  ///
kpeter@393
   103
  /// This class provides an implementation of Goldberg-Tarjan's \e preflow
kpeter@559
   104
  /// \e push-relabel algorithm producing a \ref max_flow
kpeter@559
   105
  /// "flow of maximum value" in a digraph.
kpeter@559
   106
  /// The preflow algorithms are the fastest known maximum
kpeter@689
   107
  /// flow algorithms. The current implementation uses a mixture of the
alpar@389
   108
  /// \e "highest label" and the \e "bound decrease" heuristics.
alpar@389
   109
  /// The worst case time complexity of the algorithm is \f$O(n^2\sqrt{e})\f$.
alpar@389
   110
  ///
kpeter@393
   111
  /// The algorithm consists of two phases. After the first phase
kpeter@393
   112
  /// the maximum flow value and the minimum cut is obtained. The
kpeter@393
   113
  /// second phase constructs a feasible maximum flow on each arc.
alpar@389
   114
  ///
kpeter@503
   115
  /// \tparam GR The type of the digraph the algorithm runs on.
kpeter@559
   116
  /// \tparam CAP The type of the capacity map. The default map
kpeter@503
   117
  /// type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
alpar@389
   118
#ifdef DOXYGEN
kpeter@559
   119
  template <typename GR, typename CAP, typename TR>
alpar@389
   120
#else
kpeter@503
   121
  template <typename GR,
kpeter@559
   122
            typename CAP = typename GR::template ArcMap<int>,
kpeter@559
   123
            typename TR = PreflowDefaultTraits<GR, CAP> >
alpar@389
   124
#endif
alpar@389
   125
  class Preflow {
alpar@389
   126
  public:
alpar@389
   127
kpeter@393
   128
    ///The \ref PreflowDefaultTraits "traits class" of the algorithm.
kpeter@503
   129
    typedef TR Traits;
kpeter@393
   130
    ///The type of the digraph the algorithm runs on.
alpar@389
   131
    typedef typename Traits::Digraph Digraph;
kpeter@393
   132
    ///The type of the capacity map.
alpar@389
   133
    typedef typename Traits::CapacityMap CapacityMap;
kpeter@393
   134
    ///The type of the flow values.
kpeter@641
   135
    typedef typename Traits::Value Value;
alpar@389
   136
kpeter@393
   137
    ///The type of the flow map.
alpar@389
   138
    typedef typename Traits::FlowMap FlowMap;
kpeter@393
   139
    ///The type of the elevator.
alpar@389
   140
    typedef typename Traits::Elevator Elevator;
kpeter@393
   141
    ///The type of the tolerance.
alpar@389
   142
    typedef typename Traits::Tolerance Tolerance;
alpar@389
   143
alpar@389
   144
  private:
alpar@389
   145
alpar@389
   146
    TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
alpar@389
   147
alpar@389
   148
    const Digraph& _graph;
alpar@389
   149
    const CapacityMap* _capacity;
alpar@389
   150
alpar@389
   151
    int _node_num;
alpar@389
   152
alpar@389
   153
    Node _source, _target;
alpar@389
   154
alpar@389
   155
    FlowMap* _flow;
alpar@389
   156
    bool _local_flow;
alpar@389
   157
alpar@389
   158
    Elevator* _level;
alpar@389
   159
    bool _local_level;
alpar@389
   160
kpeter@641
   161
    typedef typename Digraph::template NodeMap<Value> ExcessMap;
alpar@389
   162
    ExcessMap* _excess;
alpar@389
   163
alpar@389
   164
    Tolerance _tolerance;
alpar@389
   165
alpar@389
   166
    bool _phase;
alpar@389
   167
alpar@389
   168
alpar@389
   169
    void createStructures() {
alpar@389
   170
      _node_num = countNodes(_graph);
alpar@389
   171
alpar@389
   172
      if (!_flow) {
alpar@389
   173
        _flow = Traits::createFlowMap(_graph);
alpar@389
   174
        _local_flow = true;
alpar@389
   175
      }
alpar@389
   176
      if (!_level) {
alpar@389
   177
        _level = Traits::createElevator(_graph, _node_num);
alpar@389
   178
        _local_level = true;
alpar@389
   179
      }
alpar@389
   180
      if (!_excess) {
alpar@389
   181
        _excess = new ExcessMap(_graph);
alpar@389
   182
      }
alpar@389
   183
    }
alpar@389
   184
alpar@389
   185
    void destroyStructures() {
alpar@389
   186
      if (_local_flow) {
alpar@389
   187
        delete _flow;
alpar@389
   188
      }
alpar@389
   189
      if (_local_level) {
alpar@389
   190
        delete _level;
alpar@389
   191
      }
alpar@389
   192
      if (_excess) {
alpar@389
   193
        delete _excess;
alpar@389
   194
      }
alpar@389
   195
    }
alpar@389
   196
alpar@389
   197
  public:
alpar@389
   198
alpar@389
   199
    typedef Preflow Create;
alpar@389
   200
kpeter@393
   201
    ///\name Named Template Parameters
alpar@389
   202
alpar@389
   203
    ///@{
alpar@389
   204
kpeter@559
   205
    template <typename T>
alpar@391
   206
    struct SetFlowMapTraits : public Traits {
kpeter@559
   207
      typedef T FlowMap;
alpar@389
   208
      static FlowMap *createFlowMap(const Digraph&) {
alpar@390
   209
        LEMON_ASSERT(false, "FlowMap is not initialized");
alpar@390
   210
        return 0; // ignore warnings
alpar@389
   211
      }
alpar@389
   212
    };
alpar@389
   213
alpar@389
   214
    /// \brief \ref named-templ-param "Named parameter" for setting
alpar@389
   215
    /// FlowMap type
alpar@389
   216
    ///
alpar@389
   217
    /// \ref named-templ-param "Named parameter" for setting FlowMap
kpeter@393
   218
    /// type.
kpeter@559
   219
    template <typename T>
alpar@391
   220
    struct SetFlowMap
kpeter@559
   221
      : public Preflow<Digraph, CapacityMap, SetFlowMapTraits<T> > {
alpar@389
   222
      typedef Preflow<Digraph, CapacityMap,
kpeter@559
   223
                      SetFlowMapTraits<T> > Create;
alpar@389
   224
    };
alpar@389
   225
kpeter@559
   226
    template <typename T>
alpar@391
   227
    struct SetElevatorTraits : public Traits {
kpeter@559
   228
      typedef T Elevator;
alpar@389
   229
      static Elevator *createElevator(const Digraph&, int) {
alpar@390
   230
        LEMON_ASSERT(false, "Elevator is not initialized");
alpar@390
   231
        return 0; // ignore warnings
alpar@389
   232
      }
alpar@389
   233
    };
alpar@389
   234
alpar@389
   235
    /// \brief \ref named-templ-param "Named parameter" for setting
alpar@389
   236
    /// Elevator type
alpar@389
   237
    ///
alpar@389
   238
    /// \ref named-templ-param "Named parameter" for setting Elevator
kpeter@393
   239
    /// type. If this named parameter is used, then an external
kpeter@393
   240
    /// elevator object must be passed to the algorithm using the
kpeter@393
   241
    /// \ref elevator(Elevator&) "elevator()" function before calling
kpeter@393
   242
    /// \ref run() or \ref init().
kpeter@393
   243
    /// \sa SetStandardElevator
kpeter@559
   244
    template <typename T>
alpar@391
   245
    struct SetElevator
kpeter@559
   246
      : public Preflow<Digraph, CapacityMap, SetElevatorTraits<T> > {
alpar@389
   247
      typedef Preflow<Digraph, CapacityMap,
kpeter@559
   248
                      SetElevatorTraits<T> > Create;
alpar@389
   249
    };
alpar@389
   250
kpeter@559
   251
    template <typename T>
alpar@391
   252
    struct SetStandardElevatorTraits : public Traits {
kpeter@559
   253
      typedef T Elevator;
alpar@389
   254
      static Elevator *createElevator(const Digraph& digraph, int max_level) {
alpar@389
   255
        return new Elevator(digraph, max_level);
alpar@389
   256
      }
alpar@389
   257
    };
alpar@389
   258
alpar@389
   259
    /// \brief \ref named-templ-param "Named parameter" for setting
kpeter@393
   260
    /// Elevator type with automatic allocation
alpar@389
   261
    ///
alpar@389
   262
    /// \ref named-templ-param "Named parameter" for setting Elevator
kpeter@393
   263
    /// type with automatic allocation.
kpeter@393
   264
    /// The Elevator should have standard constructor interface to be
kpeter@393
   265
    /// able to automatically created by the algorithm (i.e. the
kpeter@393
   266
    /// digraph and the maximum level should be passed to it).
kpeter@393
   267
    /// However an external elevator object could also be passed to the
kpeter@393
   268
    /// algorithm with the \ref elevator(Elevator&) "elevator()" function
kpeter@393
   269
    /// before calling \ref run() or \ref init().
kpeter@393
   270
    /// \sa SetElevator
kpeter@559
   271
    template <typename T>
alpar@391
   272
    struct SetStandardElevator
alpar@389
   273
      : public Preflow<Digraph, CapacityMap,
kpeter@559
   274
                       SetStandardElevatorTraits<T> > {
alpar@389
   275
      typedef Preflow<Digraph, CapacityMap,
kpeter@559
   276
                      SetStandardElevatorTraits<T> > Create;
alpar@389
   277
    };
alpar@389
   278
alpar@389
   279
    /// @}
alpar@389
   280
alpar@389
   281
  protected:
alpar@389
   282
alpar@389
   283
    Preflow() {}
alpar@389
   284
alpar@389
   285
  public:
alpar@389
   286
alpar@389
   287
alpar@389
   288
    /// \brief The constructor of the class.
alpar@389
   289
    ///
alpar@389
   290
    /// The constructor of the class.
alpar@389
   291
    /// \param digraph The digraph the algorithm runs on.
alpar@389
   292
    /// \param capacity The capacity of the arcs.
alpar@389
   293
    /// \param source The source node.
alpar@389
   294
    /// \param target The target node.
alpar@389
   295
    Preflow(const Digraph& digraph, const CapacityMap& capacity,
kpeter@393
   296
            Node source, Node target)
alpar@389
   297
      : _graph(digraph), _capacity(&capacity),
alpar@389
   298
        _node_num(0), _source(source), _target(target),
alpar@389
   299
        _flow(0), _local_flow(false),
alpar@389
   300
        _level(0), _local_level(false),
alpar@389
   301
        _excess(0), _tolerance(), _phase() {}
alpar@389
   302
kpeter@393
   303
    /// \brief Destructor.
alpar@389
   304
    ///
alpar@389
   305
    /// Destructor.
alpar@389
   306
    ~Preflow() {
alpar@389
   307
      destroyStructures();
alpar@389
   308
    }
alpar@389
   309
alpar@389
   310
    /// \brief Sets the capacity map.
alpar@389
   311
    ///
alpar@389
   312
    /// Sets the capacity map.
kpeter@393
   313
    /// \return <tt>(*this)</tt>
alpar@389
   314
    Preflow& capacityMap(const CapacityMap& map) {
alpar@389
   315
      _capacity = &map;
alpar@389
   316
      return *this;
alpar@389
   317
    }
alpar@389
   318
alpar@389
   319
    /// \brief Sets the flow map.
alpar@389
   320
    ///
alpar@389
   321
    /// Sets the flow map.
kpeter@393
   322
    /// If you don't use this function before calling \ref run() or
kpeter@393
   323
    /// \ref init(), an instance will be allocated automatically.
kpeter@393
   324
    /// The destructor deallocates this automatically allocated map,
kpeter@393
   325
    /// of course.
kpeter@393
   326
    /// \return <tt>(*this)</tt>
alpar@389
   327
    Preflow& flowMap(FlowMap& map) {
alpar@389
   328
      if (_local_flow) {
alpar@389
   329
        delete _flow;
alpar@389
   330
        _local_flow = false;
alpar@389
   331
      }
alpar@389
   332
      _flow = &map;
alpar@389
   333
      return *this;
alpar@389
   334
    }
alpar@389
   335
kpeter@393
   336
    /// \brief Sets the source node.
alpar@389
   337
    ///
kpeter@393
   338
    /// Sets the source node.
kpeter@393
   339
    /// \return <tt>(*this)</tt>
kpeter@393
   340
    Preflow& source(const Node& node) {
kpeter@393
   341
      _source = node;
kpeter@393
   342
      return *this;
alpar@389
   343
    }
alpar@389
   344
kpeter@393
   345
    /// \brief Sets the target node.
alpar@389
   346
    ///
kpeter@393
   347
    /// Sets the target node.
kpeter@393
   348
    /// \return <tt>(*this)</tt>
kpeter@393
   349
    Preflow& target(const Node& node) {
kpeter@393
   350
      _target = node;
kpeter@393
   351
      return *this;
kpeter@393
   352
    }
kpeter@393
   353
kpeter@393
   354
    /// \brief Sets the elevator used by algorithm.
kpeter@393
   355
    ///
kpeter@393
   356
    /// Sets the elevator used by algorithm.
kpeter@393
   357
    /// If you don't use this function before calling \ref run() or
kpeter@393
   358
    /// \ref init(), an instance will be allocated automatically.
kpeter@393
   359
    /// The destructor deallocates this automatically allocated elevator,
kpeter@393
   360
    /// of course.
kpeter@393
   361
    /// \return <tt>(*this)</tt>
alpar@389
   362
    Preflow& elevator(Elevator& elevator) {
alpar@389
   363
      if (_local_level) {
alpar@389
   364
        delete _level;
alpar@389
   365
        _local_level = false;
alpar@389
   366
      }
alpar@389
   367
      _level = &elevator;
alpar@389
   368
      return *this;
alpar@389
   369
    }
alpar@389
   370
kpeter@393
   371
    /// \brief Returns a const reference to the elevator.
alpar@389
   372
    ///
kpeter@393
   373
    /// Returns a const reference to the elevator.
kpeter@393
   374
    ///
kpeter@393
   375
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@393
   376
    /// using this function.
kpeter@420
   377
    const Elevator& elevator() const {
alpar@389
   378
      return *_level;
alpar@389
   379
    }
alpar@389
   380
kpeter@689
   381
    /// \brief Sets the tolerance used by the algorithm.
alpar@389
   382
    ///
kpeter@689
   383
    /// Sets the tolerance object used by the algorithm.
kpeter@689
   384
    /// \return <tt>(*this)</tt>
kpeter@688
   385
    Preflow& tolerance(const Tolerance& tolerance) {
alpar@389
   386
      _tolerance = tolerance;
alpar@389
   387
      return *this;
alpar@389
   388
    }
alpar@389
   389
kpeter@393
   390
    /// \brief Returns a const reference to the tolerance.
alpar@389
   391
    ///
kpeter@689
   392
    /// Returns a const reference to the tolerance object used by
kpeter@689
   393
    /// the algorithm.
alpar@389
   394
    const Tolerance& tolerance() const {
kpeter@688
   395
      return _tolerance;
alpar@389
   396
    }
alpar@389
   397
kpeter@393
   398
    /// \name Execution Control
kpeter@393
   399
    /// The simplest way to execute the preflow algorithm is to use
kpeter@393
   400
    /// \ref run() or \ref runMinCut().\n
kpeter@713
   401
    /// If you need better control on the initial solution or the execution,
kpeter@713
   402
    /// you have to call one of the \ref init() functions first, then
kpeter@393
   403
    /// \ref startFirstPhase() and if you need it \ref startSecondPhase().
alpar@389
   404
alpar@389
   405
    ///@{
alpar@389
   406
alpar@389
   407
    /// \brief Initializes the internal data structures.
alpar@389
   408
    ///
kpeter@393
   409
    /// Initializes the internal data structures and sets the initial
kpeter@393
   410
    /// flow to zero on each arc.
alpar@389
   411
    void init() {
alpar@389
   412
      createStructures();
alpar@389
   413
alpar@389
   414
      _phase = true;
alpar@389
   415
      for (NodeIt n(_graph); n != INVALID; ++n) {
kpeter@581
   416
        (*_excess)[n] = 0;
alpar@389
   417
      }
alpar@389
   418
alpar@389
   419
      for (ArcIt e(_graph); e != INVALID; ++e) {
alpar@389
   420
        _flow->set(e, 0);
alpar@389
   421
      }
alpar@389
   422
alpar@389
   423
      typename Digraph::template NodeMap<bool> reached(_graph, false);
alpar@389
   424
alpar@389
   425
      _level->initStart();
alpar@389
   426
      _level->initAddItem(_target);
alpar@389
   427
alpar@389
   428
      std::vector<Node> queue;
kpeter@581
   429
      reached[_source] = true;
alpar@389
   430
alpar@389
   431
      queue.push_back(_target);
kpeter@581
   432
      reached[_target] = true;
alpar@389
   433
      while (!queue.empty()) {
alpar@389
   434
        _level->initNewLevel();
alpar@389
   435
        std::vector<Node> nqueue;
alpar@389
   436
        for (int i = 0; i < int(queue.size()); ++i) {
alpar@389
   437
          Node n = queue[i];
alpar@389
   438
          for (InArcIt e(_graph, n); e != INVALID; ++e) {
alpar@389
   439
            Node u = _graph.source(e);
alpar@389
   440
            if (!reached[u] && _tolerance.positive((*_capacity)[e])) {
kpeter@581
   441
              reached[u] = true;
alpar@389
   442
              _level->initAddItem(u);
alpar@389
   443
              nqueue.push_back(u);
alpar@389
   444
            }
alpar@389
   445
          }
alpar@389
   446
        }
alpar@389
   447
        queue.swap(nqueue);
alpar@389
   448
      }
alpar@389
   449
      _level->initFinish();
alpar@389
   450
alpar@389
   451
      for (OutArcIt e(_graph, _source); e != INVALID; ++e) {
alpar@389
   452
        if (_tolerance.positive((*_capacity)[e])) {
alpar@389
   453
          Node u = _graph.target(e);
alpar@389
   454
          if ((*_level)[u] == _level->maxLevel()) continue;
alpar@389
   455
          _flow->set(e, (*_capacity)[e]);
kpeter@581
   456
          (*_excess)[u] += (*_capacity)[e];
alpar@389
   457
          if (u != _target && !_level->active(u)) {
alpar@389
   458
            _level->activate(u);
alpar@389
   459
          }
alpar@389
   460
        }
alpar@389
   461
      }
alpar@389
   462
    }
alpar@389
   463
kpeter@393
   464
    /// \brief Initializes the internal data structures using the
kpeter@393
   465
    /// given flow map.
alpar@389
   466
    ///
alpar@389
   467
    /// Initializes the internal data structures and sets the initial
alpar@389
   468
    /// flow to the given \c flowMap. The \c flowMap should contain a
kpeter@393
   469
    /// flow or at least a preflow, i.e. at each node excluding the
kpeter@393
   470
    /// source node the incoming flow should greater or equal to the
alpar@389
   471
    /// outgoing flow.
kpeter@393
   472
    /// \return \c false if the given \c flowMap is not a preflow.
alpar@389
   473
    template <typename FlowMap>
kpeter@392
   474
    bool init(const FlowMap& flowMap) {
alpar@389
   475
      createStructures();
alpar@389
   476
alpar@389
   477
      for (ArcIt e(_graph); e != INVALID; ++e) {
alpar@389
   478
        _flow->set(e, flowMap[e]);
alpar@389
   479
      }
alpar@389
   480
alpar@389
   481
      for (NodeIt n(_graph); n != INVALID; ++n) {
kpeter@641
   482
        Value excess = 0;
alpar@389
   483
        for (InArcIt e(_graph, n); e != INVALID; ++e) {
alpar@389
   484
          excess += (*_flow)[e];
alpar@389
   485
        }
alpar@389
   486
        for (OutArcIt e(_graph, n); e != INVALID; ++e) {
alpar@389
   487
          excess -= (*_flow)[e];
alpar@389
   488
        }
alpar@389
   489
        if (excess < 0 && n != _source) return false;
kpeter@581
   490
        (*_excess)[n] = excess;
alpar@389
   491
      }
alpar@389
   492
alpar@389
   493
      typename Digraph::template NodeMap<bool> reached(_graph, false);
alpar@389
   494
alpar@389
   495
      _level->initStart();
alpar@389
   496
      _level->initAddItem(_target);
alpar@389
   497
alpar@389
   498
      std::vector<Node> queue;
kpeter@581
   499
      reached[_source] = true;
alpar@389
   500
alpar@389
   501
      queue.push_back(_target);
kpeter@581
   502
      reached[_target] = true;
alpar@389
   503
      while (!queue.empty()) {
alpar@389
   504
        _level->initNewLevel();
alpar@389
   505
        std::vector<Node> nqueue;
alpar@389
   506
        for (int i = 0; i < int(queue.size()); ++i) {
alpar@389
   507
          Node n = queue[i];
alpar@389
   508
          for (InArcIt e(_graph, n); e != INVALID; ++e) {
alpar@389
   509
            Node u = _graph.source(e);
alpar@389
   510
            if (!reached[u] &&
alpar@389
   511
                _tolerance.positive((*_capacity)[e] - (*_flow)[e])) {
kpeter@581
   512
              reached[u] = true;
alpar@389
   513
              _level->initAddItem(u);
alpar@389
   514
              nqueue.push_back(u);
alpar@389
   515
            }
alpar@389
   516
          }
alpar@389
   517
          for (OutArcIt e(_graph, n); e != INVALID; ++e) {
alpar@389
   518
            Node v = _graph.target(e);
alpar@389
   519
            if (!reached[v] && _tolerance.positive((*_flow)[e])) {
kpeter@581
   520
              reached[v] = true;
alpar@389
   521
              _level->initAddItem(v);
alpar@389
   522
              nqueue.push_back(v);
alpar@389
   523
            }
alpar@389
   524
          }
alpar@389
   525
        }
alpar@389
   526
        queue.swap(nqueue);
alpar@389
   527
      }
alpar@389
   528
      _level->initFinish();
alpar@389
   529
alpar@389
   530
      for (OutArcIt e(_graph, _source); e != INVALID; ++e) {
kpeter@641
   531
        Value rem = (*_capacity)[e] - (*_flow)[e];
alpar@389
   532
        if (_tolerance.positive(rem)) {
alpar@389
   533
          Node u = _graph.target(e);
alpar@389
   534
          if ((*_level)[u] == _level->maxLevel()) continue;
alpar@389
   535
          _flow->set(e, (*_capacity)[e]);
kpeter@581
   536
          (*_excess)[u] += rem;
alpar@389
   537
          if (u != _target && !_level->active(u)) {
alpar@389
   538
            _level->activate(u);
alpar@389
   539
          }
alpar@389
   540
        }
alpar@389
   541
      }
alpar@389
   542
      for (InArcIt e(_graph, _source); e != INVALID; ++e) {
kpeter@641
   543
        Value rem = (*_flow)[e];
alpar@389
   544
        if (_tolerance.positive(rem)) {
alpar@389
   545
          Node v = _graph.source(e);
alpar@389
   546
          if ((*_level)[v] == _level->maxLevel()) continue;
alpar@389
   547
          _flow->set(e, 0);
kpeter@581
   548
          (*_excess)[v] += rem;
alpar@389
   549
          if (v != _target && !_level->active(v)) {
alpar@389
   550
            _level->activate(v);
alpar@389
   551
          }
alpar@389
   552
        }
alpar@389
   553
      }
alpar@389
   554
      return true;
alpar@389
   555
    }
alpar@389
   556
alpar@389
   557
    /// \brief Starts the first phase of the preflow algorithm.
alpar@389
   558
    ///
alpar@389
   559
    /// The preflow algorithm consists of two phases, this method runs
alpar@389
   560
    /// the first phase. After the first phase the maximum flow value
alpar@389
   561
    /// and a minimum value cut can already be computed, although a
alpar@389
   562
    /// maximum flow is not yet obtained. So after calling this method
alpar@389
   563
    /// \ref flowValue() returns the value of a maximum flow and \ref
alpar@389
   564
    /// minCut() returns a minimum cut.
kpeter@393
   565
    /// \pre One of the \ref init() functions must be called before
kpeter@393
   566
    /// using this function.
alpar@389
   567
    void startFirstPhase() {
alpar@389
   568
      _phase = true;
alpar@389
   569
alpar@389
   570
      Node n = _level->highestActive();
alpar@389
   571
      int level = _level->highestActiveLevel();
alpar@389
   572
      while (n != INVALID) {
alpar@389
   573
        int num = _node_num;
alpar@389
   574
alpar@389
   575
        while (num > 0 && n != INVALID) {
kpeter@641
   576
          Value excess = (*_excess)[n];
alpar@389
   577
          int new_level = _level->maxLevel();
alpar@389
   578
alpar@389
   579
          for (OutArcIt e(_graph, n); e != INVALID; ++e) {
kpeter@641
   580
            Value rem = (*_capacity)[e] - (*_flow)[e];
alpar@389
   581
            if (!_tolerance.positive(rem)) continue;
alpar@389
   582
            Node v = _graph.target(e);
alpar@389
   583
            if ((*_level)[v] < level) {
alpar@389
   584
              if (!_level->active(v) && v != _target) {
alpar@389
   585
                _level->activate(v);
alpar@389
   586
              }
alpar@389
   587
              if (!_tolerance.less(rem, excess)) {
alpar@389
   588
                _flow->set(e, (*_flow)[e] + excess);
kpeter@581
   589
                (*_excess)[v] += excess;
alpar@389
   590
                excess = 0;
alpar@389
   591
                goto no_more_push_1;
alpar@389
   592
              } else {
alpar@389
   593
                excess -= rem;
kpeter@581
   594
                (*_excess)[v] += rem;
alpar@389
   595
                _flow->set(e, (*_capacity)[e]);
alpar@389
   596
              }
alpar@389
   597
            } else if (new_level > (*_level)[v]) {
alpar@389
   598
              new_level = (*_level)[v];
alpar@389
   599
            }
alpar@389
   600
          }
alpar@389
   601
alpar@389
   602
          for (InArcIt e(_graph, n); e != INVALID; ++e) {
kpeter@641
   603
            Value rem = (*_flow)[e];
alpar@389
   604
            if (!_tolerance.positive(rem)) continue;
alpar@389
   605
            Node v = _graph.source(e);
alpar@389
   606
            if ((*_level)[v] < level) {
alpar@389
   607
              if (!_level->active(v) && v != _target) {
alpar@389
   608
                _level->activate(v);
alpar@389
   609
              }
alpar@389
   610
              if (!_tolerance.less(rem, excess)) {
alpar@389
   611
                _flow->set(e, (*_flow)[e] - excess);
kpeter@581
   612
                (*_excess)[v] += excess;
alpar@389
   613
                excess = 0;
alpar@389
   614
                goto no_more_push_1;
alpar@389
   615
              } else {
alpar@389
   616
                excess -= rem;
kpeter@581
   617
                (*_excess)[v] += rem;
alpar@389
   618
                _flow->set(e, 0);
alpar@389
   619
              }
alpar@389
   620
            } else if (new_level > (*_level)[v]) {
alpar@389
   621
              new_level = (*_level)[v];
alpar@389
   622
            }
alpar@389
   623
          }
alpar@389
   624
alpar@389
   625
        no_more_push_1:
alpar@389
   626
kpeter@581
   627
          (*_excess)[n] = excess;
alpar@389
   628
alpar@389
   629
          if (excess != 0) {
alpar@389
   630
            if (new_level + 1 < _level->maxLevel()) {
alpar@389
   631
              _level->liftHighestActive(new_level + 1);
alpar@389
   632
            } else {
alpar@389
   633
              _level->liftHighestActiveToTop();
alpar@389
   634
            }
alpar@389
   635
            if (_level->emptyLevel(level)) {
alpar@389
   636
              _level->liftToTop(level);
alpar@389
   637
            }
alpar@389
   638
          } else {
alpar@389
   639
            _level->deactivate(n);
alpar@389
   640
          }
alpar@389
   641
alpar@389
   642
          n = _level->highestActive();
alpar@389
   643
          level = _level->highestActiveLevel();
alpar@389
   644
          --num;
alpar@389
   645
        }
alpar@389
   646
alpar@389
   647
        num = _node_num * 20;
alpar@389
   648
        while (num > 0 && n != INVALID) {
kpeter@641
   649
          Value excess = (*_excess)[n];
alpar@389
   650
          int new_level = _level->maxLevel();
alpar@389
   651
alpar@389
   652
          for (OutArcIt e(_graph, n); e != INVALID; ++e) {
kpeter@641
   653
            Value rem = (*_capacity)[e] - (*_flow)[e];
alpar@389
   654
            if (!_tolerance.positive(rem)) continue;
alpar@389
   655
            Node v = _graph.target(e);
alpar@389
   656
            if ((*_level)[v] < level) {
alpar@389
   657
              if (!_level->active(v) && v != _target) {
alpar@389
   658
                _level->activate(v);
alpar@389
   659
              }
alpar@389
   660
              if (!_tolerance.less(rem, excess)) {
alpar@389
   661
                _flow->set(e, (*_flow)[e] + excess);
kpeter@581
   662
                (*_excess)[v] += excess;
alpar@389
   663
                excess = 0;
alpar@389
   664
                goto no_more_push_2;
alpar@389
   665
              } else {
alpar@389
   666
                excess -= rem;
kpeter@581
   667
                (*_excess)[v] += rem;
alpar@389
   668
                _flow->set(e, (*_capacity)[e]);
alpar@389
   669
              }
alpar@389
   670
            } else if (new_level > (*_level)[v]) {
alpar@389
   671
              new_level = (*_level)[v];
alpar@389
   672
            }
alpar@389
   673
          }
alpar@389
   674
alpar@389
   675
          for (InArcIt e(_graph, n); e != INVALID; ++e) {
kpeter@641
   676
            Value rem = (*_flow)[e];
alpar@389
   677
            if (!_tolerance.positive(rem)) continue;
alpar@389
   678
            Node v = _graph.source(e);
alpar@389
   679
            if ((*_level)[v] < level) {
alpar@389
   680
              if (!_level->active(v) && v != _target) {
alpar@389
   681
                _level->activate(v);
alpar@389
   682
              }
alpar@389
   683
              if (!_tolerance.less(rem, excess)) {
alpar@389
   684
                _flow->set(e, (*_flow)[e] - excess);
kpeter@581
   685
                (*_excess)[v] += excess;
alpar@389
   686
                excess = 0;
alpar@389
   687
                goto no_more_push_2;
alpar@389
   688
              } else {
alpar@389
   689
                excess -= rem;
kpeter@581
   690
                (*_excess)[v] += rem;
alpar@389
   691
                _flow->set(e, 0);
alpar@389
   692
              }
alpar@389
   693
            } else if (new_level > (*_level)[v]) {
alpar@389
   694
              new_level = (*_level)[v];
alpar@389
   695
            }
alpar@389
   696
          }
alpar@389
   697
alpar@389
   698
        no_more_push_2:
alpar@389
   699
kpeter@581
   700
          (*_excess)[n] = excess;
alpar@389
   701
alpar@389
   702
          if (excess != 0) {
alpar@389
   703
            if (new_level + 1 < _level->maxLevel()) {
alpar@389
   704
              _level->liftActiveOn(level, new_level + 1);
alpar@389
   705
            } else {
alpar@389
   706
              _level->liftActiveToTop(level);
alpar@389
   707
            }
alpar@389
   708
            if (_level->emptyLevel(level)) {
alpar@389
   709
              _level->liftToTop(level);
alpar@389
   710
            }
alpar@389
   711
          } else {
alpar@389
   712
            _level->deactivate(n);
alpar@389
   713
          }
alpar@389
   714
alpar@389
   715
          while (level >= 0 && _level->activeFree(level)) {
alpar@389
   716
            --level;
alpar@389
   717
          }
alpar@389
   718
          if (level == -1) {
alpar@389
   719
            n = _level->highestActive();
alpar@389
   720
            level = _level->highestActiveLevel();
alpar@389
   721
          } else {
alpar@389
   722
            n = _level->activeOn(level);
alpar@389
   723
          }
alpar@389
   724
          --num;
alpar@389
   725
        }
alpar@389
   726
      }
alpar@389
   727
    }
alpar@389
   728
alpar@389
   729
    /// \brief Starts the second phase of the preflow algorithm.
alpar@389
   730
    ///
alpar@389
   731
    /// The preflow algorithm consists of two phases, this method runs
kpeter@393
   732
    /// the second phase. After calling one of the \ref init() functions
kpeter@393
   733
    /// and \ref startFirstPhase() and then \ref startSecondPhase(),
kpeter@393
   734
    /// \ref flowMap() returns a maximum flow, \ref flowValue() returns the
alpar@389
   735
    /// value of a maximum flow, \ref minCut() returns a minimum cut
kpeter@393
   736
    /// \pre One of the \ref init() functions and \ref startFirstPhase()
kpeter@393
   737
    /// must be called before using this function.
alpar@389
   738
    void startSecondPhase() {
alpar@389
   739
      _phase = false;
alpar@389
   740
alpar@389
   741
      typename Digraph::template NodeMap<bool> reached(_graph);
alpar@389
   742
      for (NodeIt n(_graph); n != INVALID; ++n) {
kpeter@581
   743
        reached[n] = (*_level)[n] < _level->maxLevel();
alpar@389
   744
      }
alpar@389
   745
alpar@389
   746
      _level->initStart();
alpar@389
   747
      _level->initAddItem(_source);
alpar@389
   748
alpar@389
   749
      std::vector<Node> queue;
alpar@389
   750
      queue.push_back(_source);
kpeter@581
   751
      reached[_source] = true;
alpar@389
   752
alpar@389
   753
      while (!queue.empty()) {
alpar@389
   754
        _level->initNewLevel();
alpar@389
   755
        std::vector<Node> nqueue;
alpar@389
   756
        for (int i = 0; i < int(queue.size()); ++i) {
alpar@389
   757
          Node n = queue[i];
alpar@389
   758
          for (OutArcIt e(_graph, n); e != INVALID; ++e) {
alpar@389
   759
            Node v = _graph.target(e);
alpar@389
   760
            if (!reached[v] && _tolerance.positive((*_flow)[e])) {
kpeter@581
   761
              reached[v] = true;
alpar@389
   762
              _level->initAddItem(v);
alpar@389
   763
              nqueue.push_back(v);
alpar@389
   764
            }
alpar@389
   765
          }
alpar@389
   766
          for (InArcIt e(_graph, n); e != INVALID; ++e) {
alpar@389
   767
            Node u = _graph.source(e);
alpar@389
   768
            if (!reached[u] &&
alpar@389
   769
                _tolerance.positive((*_capacity)[e] - (*_flow)[e])) {
kpeter@581
   770
              reached[u] = true;
alpar@389
   771
              _level->initAddItem(u);
alpar@389
   772
              nqueue.push_back(u);
alpar@389
   773
            }
alpar@389
   774
          }
alpar@389
   775
        }
alpar@389
   776
        queue.swap(nqueue);
alpar@389
   777
      }
alpar@389
   778
      _level->initFinish();
alpar@389
   779
alpar@389
   780
      for (NodeIt n(_graph); n != INVALID; ++n) {
alpar@389
   781
        if (!reached[n]) {
alpar@389
   782
          _level->dirtyTopButOne(n);
alpar@389
   783
        } else if ((*_excess)[n] > 0 && _target != n) {
alpar@389
   784
          _level->activate(n);
alpar@389
   785
        }
alpar@389
   786
      }
alpar@389
   787
alpar@389
   788
      Node n;
alpar@389
   789
      while ((n = _level->highestActive()) != INVALID) {
kpeter@641
   790
        Value excess = (*_excess)[n];
alpar@389
   791
        int level = _level->highestActiveLevel();
alpar@389
   792
        int new_level = _level->maxLevel();
alpar@389
   793
alpar@389
   794
        for (OutArcIt e(_graph, n); e != INVALID; ++e) {
kpeter@641
   795
          Value rem = (*_capacity)[e] - (*_flow)[e];
alpar@389
   796
          if (!_tolerance.positive(rem)) continue;
alpar@389
   797
          Node v = _graph.target(e);
alpar@389
   798
          if ((*_level)[v] < level) {
alpar@389
   799
            if (!_level->active(v) && v != _source) {
alpar@389
   800
              _level->activate(v);
alpar@389
   801
            }
alpar@389
   802
            if (!_tolerance.less(rem, excess)) {
alpar@389
   803
              _flow->set(e, (*_flow)[e] + excess);
kpeter@581
   804
              (*_excess)[v] += excess;
alpar@389
   805
              excess = 0;
alpar@389
   806
              goto no_more_push;
alpar@389
   807
            } else {
alpar@389
   808
              excess -= rem;
kpeter@581
   809
              (*_excess)[v] += rem;
alpar@389
   810
              _flow->set(e, (*_capacity)[e]);
alpar@389
   811
            }
alpar@389
   812
          } else if (new_level > (*_level)[v]) {
alpar@389
   813
            new_level = (*_level)[v];
alpar@389
   814
          }
alpar@389
   815
        }
alpar@389
   816
alpar@389
   817
        for (InArcIt e(_graph, n); e != INVALID; ++e) {
kpeter@641
   818
          Value rem = (*_flow)[e];
alpar@389
   819
          if (!_tolerance.positive(rem)) continue;
alpar@389
   820
          Node v = _graph.source(e);
alpar@389
   821
          if ((*_level)[v] < level) {
alpar@389
   822
            if (!_level->active(v) && v != _source) {
alpar@389
   823
              _level->activate(v);
alpar@389
   824
            }
alpar@389
   825
            if (!_tolerance.less(rem, excess)) {
alpar@389
   826
              _flow->set(e, (*_flow)[e] - excess);
kpeter@581
   827
              (*_excess)[v] += excess;
alpar@389
   828
              excess = 0;
alpar@389
   829
              goto no_more_push;
alpar@389
   830
            } else {
alpar@389
   831
              excess -= rem;
kpeter@581
   832
              (*_excess)[v] += rem;
alpar@389
   833
              _flow->set(e, 0);
alpar@389
   834
            }
alpar@389
   835
          } else if (new_level > (*_level)[v]) {
alpar@389
   836
            new_level = (*_level)[v];
alpar@389
   837
          }
alpar@389
   838
        }
alpar@389
   839
alpar@389
   840
      no_more_push:
alpar@389
   841
kpeter@581
   842
        (*_excess)[n] = excess;
alpar@389
   843
alpar@389
   844
        if (excess != 0) {
alpar@389
   845
          if (new_level + 1 < _level->maxLevel()) {
alpar@389
   846
            _level->liftHighestActive(new_level + 1);
alpar@389
   847
          } else {
alpar@389
   848
            // Calculation error
alpar@389
   849
            _level->liftHighestActiveToTop();
alpar@389
   850
          }
alpar@389
   851
          if (_level->emptyLevel(level)) {
alpar@389
   852
            // Calculation error
alpar@389
   853
            _level->liftToTop(level);
alpar@389
   854
          }
alpar@389
   855
        } else {
alpar@389
   856
          _level->deactivate(n);
alpar@389
   857
        }
alpar@389
   858
alpar@389
   859
      }
alpar@389
   860
    }
alpar@389
   861
alpar@389
   862
    /// \brief Runs the preflow algorithm.
alpar@389
   863
    ///
alpar@389
   864
    /// Runs the preflow algorithm.
alpar@389
   865
    /// \note pf.run() is just a shortcut of the following code.
alpar@389
   866
    /// \code
alpar@389
   867
    ///   pf.init();
alpar@389
   868
    ///   pf.startFirstPhase();
alpar@389
   869
    ///   pf.startSecondPhase();
alpar@389
   870
    /// \endcode
alpar@389
   871
    void run() {
alpar@389
   872
      init();
alpar@389
   873
      startFirstPhase();
alpar@389
   874
      startSecondPhase();
alpar@389
   875
    }
alpar@389
   876
alpar@389
   877
    /// \brief Runs the preflow algorithm to compute the minimum cut.
alpar@389
   878
    ///
alpar@389
   879
    /// Runs the preflow algorithm to compute the minimum cut.
alpar@389
   880
    /// \note pf.runMinCut() is just a shortcut of the following code.
alpar@389
   881
    /// \code
alpar@389
   882
    ///   pf.init();
alpar@389
   883
    ///   pf.startFirstPhase();
alpar@389
   884
    /// \endcode
alpar@389
   885
    void runMinCut() {
alpar@389
   886
      init();
alpar@389
   887
      startFirstPhase();
alpar@389
   888
    }
alpar@389
   889
alpar@389
   890
    /// @}
alpar@389
   891
alpar@389
   892
    /// \name Query Functions
kpeter@393
   893
    /// The results of the preflow algorithm can be obtained using these
alpar@389
   894
    /// functions.\n
kpeter@393
   895
    /// Either one of the \ref run() "run*()" functions or one of the
kpeter@393
   896
    /// \ref startFirstPhase() "start*()" functions should be called
kpeter@393
   897
    /// before using them.
alpar@389
   898
alpar@389
   899
    ///@{
alpar@389
   900
alpar@389
   901
    /// \brief Returns the value of the maximum flow.
alpar@389
   902
    ///
alpar@389
   903
    /// Returns the value of the maximum flow by returning the excess
kpeter@393
   904
    /// of the target node. This value equals to the value of
kpeter@393
   905
    /// the maximum flow already after the first phase of the algorithm.
kpeter@393
   906
    ///
kpeter@393
   907
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@393
   908
    /// using this function.
kpeter@641
   909
    Value flowValue() const {
alpar@389
   910
      return (*_excess)[_target];
alpar@389
   911
    }
alpar@389
   912
kpeter@641
   913
    /// \brief Returns the flow value on the given arc.
alpar@389
   914
    ///
kpeter@641
   915
    /// Returns the flow value on the given arc. This method can
kpeter@393
   916
    /// be called after the second phase of the algorithm.
kpeter@393
   917
    ///
kpeter@393
   918
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@393
   919
    /// using this function.
kpeter@641
   920
    Value flow(const Arc& arc) const {
kpeter@393
   921
      return (*_flow)[arc];
kpeter@393
   922
    }
kpeter@393
   923
kpeter@393
   924
    /// \brief Returns a const reference to the flow map.
kpeter@393
   925
    ///
kpeter@393
   926
    /// Returns a const reference to the arc map storing the found flow.
kpeter@393
   927
    /// This method can be called after the second phase of the algorithm.
kpeter@393
   928
    ///
kpeter@393
   929
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@393
   930
    /// using this function.
kpeter@420
   931
    const FlowMap& flowMap() const {
kpeter@393
   932
      return *_flow;
kpeter@393
   933
    }
kpeter@393
   934
kpeter@393
   935
    /// \brief Returns \c true when the node is on the source side of the
kpeter@393
   936
    /// minimum cut.
kpeter@393
   937
    ///
kpeter@393
   938
    /// Returns true when the node is on the source side of the found
kpeter@393
   939
    /// minimum cut. This method can be called both after running \ref
alpar@389
   940
    /// startFirstPhase() and \ref startSecondPhase().
kpeter@393
   941
    ///
kpeter@393
   942
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@393
   943
    /// using this function.
alpar@389
   944
    bool minCut(const Node& node) const {
alpar@389
   945
      return ((*_level)[node] == _level->maxLevel()) == _phase;
alpar@389
   946
    }
alpar@389
   947
kpeter@393
   948
    /// \brief Gives back a minimum value cut.
alpar@389
   949
    ///
kpeter@393
   950
    /// Sets \c cutMap to the characteristic vector of a minimum value
kpeter@393
   951
    /// cut. \c cutMap should be a \ref concepts::WriteMap "writable"
kpeter@393
   952
    /// node map with \c bool (or convertible) value type.
kpeter@393
   953
    ///
kpeter@393
   954
    /// This method can be called both after running \ref startFirstPhase()
kpeter@393
   955
    /// and \ref startSecondPhase(). The result after the second phase
kpeter@393
   956
    /// could be slightly different if inexact computation is used.
kpeter@393
   957
    ///
kpeter@393
   958
    /// \note This function calls \ref minCut() for each node, so it runs in
kpeter@559
   959
    /// O(n) time.
kpeter@393
   960
    ///
kpeter@393
   961
    /// \pre Either \ref run() or \ref init() must be called before
kpeter@393
   962
    /// using this function.
alpar@389
   963
    template <typename CutMap>
alpar@389
   964
    void minCutMap(CutMap& cutMap) const {
alpar@389
   965
      for (NodeIt n(_graph); n != INVALID; ++n) {
alpar@389
   966
        cutMap.set(n, minCut(n));
alpar@389
   967
      }
alpar@389
   968
    }
alpar@389
   969
alpar@389
   970
    /// @}
alpar@389
   971
  };
alpar@389
   972
}
alpar@389
   973
alpar@389
   974
#endif