lemon/preflow.h
author deba
Fri, 04 Nov 2005 19:19:52 +0000
changeset 1778 4ba7965386fb
parent 1742 2637b9420d0a
child 1786 a263c131e999
permissions -rw-r--r--
Some just writeable bool maps.
alpar@906
     1
/* -*- C++ -*-
ladanyi@1435
     2
 * lemon/preflow.h - Part of LEMON, a generic C++ optimization library
alpar@906
     3
 *
alpar@1164
     4
 * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
alpar@1359
     5
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
alpar@906
     6
 *
alpar@906
     7
 * Permission to use, modify and distribute this software is granted
alpar@906
     8
 * provided that this copyright notice appears in all copies. For
alpar@906
     9
 * precise terms see the accompanying LICENSE file.
alpar@906
    10
 *
alpar@906
    11
 * This software is provided "AS IS" with no warranty of any kind,
alpar@906
    12
 * express or implied, and with no claim as to its suitability for any
alpar@906
    13
 * purpose.
alpar@906
    14
 *
alpar@906
    15
 */
alpar@906
    16
alpar@921
    17
#ifndef LEMON_PREFLOW_H
alpar@921
    18
#define LEMON_PREFLOW_H
jacint@836
    19
jacint@836
    20
#include <vector>
jacint@836
    21
#include <queue>
jacint@836
    22
jacint@1762
    23
#include <lemon/error.h>
alpar@921
    24
#include <lemon/invalid.h>
alpar@921
    25
#include <lemon/maps.h>
klao@977
    26
#include <lemon/graph_utils.h>
jacint@836
    27
jacint@836
    28
/// \file
jacint@836
    29
/// \ingroup flowalgs
deba@1742
    30
/// \brief Implementation of the preflow algorithm.
jacint@836
    31
alpar@921
    32
namespace lemon {
jacint@836
    33
jacint@836
    34
  /// \addtogroup flowalgs
jacint@836
    35
  /// @{                                                   
jacint@836
    36
alpar@851
    37
  ///%Preflow algorithms class.
jacint@836
    38
jacint@836
    39
  ///This class provides an implementation of the \e preflow \e
jacint@836
    40
  ///algorithm producing a flow of maximum value in a directed
alpar@1222
    41
  ///graph. The preflow algorithms are the fastest known max flow algorithms
alpar@851
    42
  ///up to now. The \e source node, the \e target node, the \e
jacint@836
    43
  ///capacity of the edges and the \e starting \e flow value of the
jacint@836
    44
  ///edges should be passed to the algorithm through the
jacint@836
    45
  ///constructor. It is possible to change these quantities using the
zsuzska@1285
    46
  ///functions \ref source, \ref target, \ref capacityMap and \ref
zsuzska@1285
    47
  ///flowMap.
jacint@836
    48
  ///
alpar@921
    49
  ///After running \ref lemon::Preflow::phase1() "phase1()"
alpar@921
    50
  ///or \ref lemon::Preflow::run() "run()", the maximal flow
jacint@836
    51
  ///value can be obtained by calling \ref flowValue(). The minimum
alpar@851
    52
  ///value cut can be written into a <tt>bool</tt> node map by
alpar@851
    53
  ///calling \ref minCut(). (\ref minMinCut() and \ref maxMinCut() writes
jacint@836
    54
  ///the inclusionwise minimum and maximum of the minimum value cuts,
jacint@836
    55
  ///resp.)
jacint@836
    56
  ///
jacint@836
    57
  ///\param Graph The directed graph type the algorithm runs on.
jacint@836
    58
  ///\param Num The number type of the capacities and the flow values.
alpar@1222
    59
  ///\param CapacityMap The capacity map type.
jacint@836
    60
  ///\param FlowMap The flow map type.
jacint@836
    61
  ///
jacint@836
    62
  ///\author Jacint Szabo 
alpar@1227
    63
  ///\todo Second template parameter is superfluous
jacint@836
    64
  template <typename Graph, typename Num,
alpar@1222
    65
	    typename CapacityMap=typename Graph::template EdgeMap<Num>,
jacint@836
    66
            typename FlowMap=typename Graph::template EdgeMap<Num> >
jacint@836
    67
  class Preflow {
jacint@836
    68
  protected:
jacint@836
    69
    typedef typename Graph::Node Node;
jacint@836
    70
    typedef typename Graph::NodeIt NodeIt;
jacint@836
    71
    typedef typename Graph::EdgeIt EdgeIt;
jacint@836
    72
    typedef typename Graph::OutEdgeIt OutEdgeIt;
jacint@836
    73
    typedef typename Graph::InEdgeIt InEdgeIt;
jacint@836
    74
jacint@836
    75
    typedef typename Graph::template NodeMap<Node> NNMap;
jacint@836
    76
    typedef typename std::vector<Node> VecNode;
jacint@836
    77
alpar@1222
    78
    const Graph* _g;
alpar@1222
    79
    Node _source;
alpar@1222
    80
    Node _target;
alpar@1222
    81
    const CapacityMap* _capacity;
alpar@1222
    82
    FlowMap* _flow;
alpar@1222
    83
    int _node_num;      //the number of nodes of G
jacint@836
    84
    
jacint@836
    85
    typename Graph::template NodeMap<int> level;  
jacint@836
    86
    typename Graph::template NodeMap<Num> excess;
jacint@836
    87
jacint@836
    88
    // constants used for heuristics
jacint@836
    89
    static const int H0=20;
jacint@836
    90
    static const int H1=1;
jacint@836
    91
jacint@1762
    92
  public:
jacint@1762
    93
jacint@1762
    94
    ///\ref Exception for the case when s=t.
jacint@1762
    95
jacint@1762
    96
    ///\ref Exception for the case when the source equals the target.
jacint@1762
    97
    class InvalidArgument : public lemon::LogicError {
jacint@836
    98
    public:
jacint@1762
    99
      virtual const char* exceptionName() const {
jacint@1762
   100
	return "lemon::Preflow::InvalidArgument";
jacint@1762
   101
      }
jacint@1762
   102
    };
jacint@1762
   103
    
jacint@1762
   104
    
jacint@836
   105
    ///Indicates the property of the starting flow map.
jacint@1762
   106
    
alpar@1222
   107
    ///Indicates the property of the starting flow map.
alpar@1222
   108
    ///The meanings are as follows:
jacint@836
   109
    ///- \c ZERO_FLOW: constant zero flow
jacint@836
   110
    ///- \c GEN_FLOW: any flow, i.e. the sum of the in-flows equals to
jacint@836
   111
    ///the sum of the out-flows in every node except the \e source and
jacint@836
   112
    ///the \e target.
jacint@836
   113
    ///- \c PRE_FLOW: any preflow, i.e. the sum of the in-flows is at 
jacint@836
   114
    ///least the sum of the out-flows in every node except the \e source.
alpar@911
   115
    ///- \c NO_FLOW: indicates an unspecified edge map. \c flow will be 
alpar@911
   116
    ///set to the constant zero flow in the beginning of
alpar@911
   117
    ///the algorithm in this case.
jacint@836
   118
    ///
jacint@836
   119
    enum FlowEnum{
jacint@836
   120
      NO_FLOW,
jacint@836
   121
      ZERO_FLOW,
jacint@836
   122
      GEN_FLOW,
jacint@836
   123
      PRE_FLOW
jacint@836
   124
    };
jacint@836
   125
jacint@836
   126
    ///Indicates the state of the preflow algorithm.
jacint@836
   127
alpar@1222
   128
    ///Indicates the state of the preflow algorithm.
alpar@1222
   129
    ///The meanings are as follows:
alpar@1222
   130
    ///- \c AFTER_NOTHING: before running the algorithm or
alpar@1222
   131
    ///  at an unspecified state.
jacint@836
   132
    ///- \c AFTER_PREFLOW_PHASE_1: right after running \c phase1
jacint@836
   133
    ///- \c AFTER_PREFLOW_PHASE_2: after running \ref phase2()
jacint@836
   134
    ///
jacint@836
   135
    enum StatusEnum {
jacint@836
   136
      AFTER_NOTHING,
jacint@836
   137
      AFTER_PREFLOW_PHASE_1,      
jacint@836
   138
      AFTER_PREFLOW_PHASE_2
jacint@836
   139
    };
jacint@836
   140
    
jacint@1762
   141
  protected: 
jacint@1762
   142
    FlowEnum flow_prop;
jacint@836
   143
    StatusEnum status; // Do not needle this flag only if necessary.
jacint@836
   144
    
jacint@836
   145
  public: 
jacint@836
   146
    ///The constructor of the class.
jacint@836
   147
jacint@836
   148
    ///The constructor of the class. 
zsuzska@1285
   149
    ///\param _gr The directed graph the algorithm runs on. 
jacint@836
   150
    ///\param _s The source node.
jacint@836
   151
    ///\param _t The target node.
alpar@1222
   152
    ///\param _cap The capacity of the edges. 
alpar@1222
   153
    ///\param _f The flow of the edges. 
jacint@836
   154
    ///Except the graph, all of these parameters can be reset by
zsuzska@1285
   155
    ///calling \ref source, \ref target, \ref capacityMap and \ref
zsuzska@1285
   156
    ///flowMap, resp.
alpar@1222
   157
      Preflow(const Graph& _gr, Node _s, Node _t, 
alpar@1222
   158
	      const CapacityMap& _cap, FlowMap& _f) :
alpar@1222
   159
	_g(&_gr), _source(_s), _target(_t), _capacity(&_cap),
alpar@1222
   160
	_flow(&_f), _node_num(countNodes(_gr)), level(_gr), excess(_gr,0), 
jacint@1762
   161
	flow_prop(NO_FLOW), status(AFTER_NOTHING) { 
jacint@1762
   162
	if ( _source==_target )
jacint@1762
   163
	  throw InvalidArgument();
jacint@1762
   164
      }
jacint@1762
   165
    
jacint@836
   166
jacint@836
   167
                                                                              
jacint@836
   168
    ///Runs the preflow algorithm.  
jacint@836
   169
alpar@851
   170
    ///Runs the preflow algorithm.
alpar@851
   171
    ///
jacint@836
   172
    void run() {
jacint@836
   173
      phase1(flow_prop);
jacint@836
   174
      phase2();
jacint@836
   175
    }
jacint@836
   176
    
jacint@836
   177
    ///Runs the preflow algorithm.  
jacint@836
   178
    
jacint@836
   179
    ///Runs the preflow algorithm. 
jacint@836
   180
    ///\pre The starting flow map must be
jacint@836
   181
    /// - a constant zero flow if \c fp is \c ZERO_FLOW,
jacint@836
   182
    /// - an arbitrary flow if \c fp is \c GEN_FLOW,
jacint@836
   183
    /// - an arbitrary preflow if \c fp is \c PRE_FLOW,
jacint@836
   184
    /// - any map if \c fp is NO_FLOW.
jacint@836
   185
    ///If the starting flow map is a flow or a preflow then 
jacint@836
   186
    ///the algorithm terminates faster.
jacint@836
   187
    void run(FlowEnum fp) {
jacint@836
   188
      flow_prop=fp;
jacint@836
   189
      run();
jacint@836
   190
    }
jacint@836
   191
      
jacint@836
   192
    ///Runs the first phase of the preflow algorithm.
jacint@836
   193
jacint@920
   194
    ///The preflow algorithm consists of two phases, this method runs
jacint@920
   195
    ///the first phase. After the first phase the maximum flow value
zsuzska@1285
   196
    ///and a minimum value cut can already be computed, although a
jacint@920
   197
    ///maximum flow is not yet obtained. So after calling this method
jacint@920
   198
    ///\ref flowValue returns the value of a maximum flow and \ref
jacint@920
   199
    ///minCut returns a minimum cut.     
jacint@920
   200
    ///\warning \ref minMinCut and \ref maxMinCut do not give minimum
jacint@920
   201
    ///value cuts unless calling \ref phase2.  
jacint@920
   202
    ///\pre The starting flow must be 
jacint@920
   203
    ///- a constant zero flow if \c fp is \c ZERO_FLOW, 
jacint@920
   204
    ///- an arbitary flow if \c fp is \c GEN_FLOW, 
jacint@920
   205
    ///- an arbitary preflow if \c fp is \c PRE_FLOW, 
jacint@920
   206
    ///- any map if \c fp is NO_FLOW.
jacint@836
   207
    void phase1(FlowEnum fp)
jacint@836
   208
    {
jacint@836
   209
      flow_prop=fp;
jacint@836
   210
      phase1();
jacint@836
   211
    }
jacint@836
   212
jacint@836
   213
    
jacint@836
   214
    ///Runs the first phase of the preflow algorithm.
jacint@836
   215
jacint@920
   216
    ///The preflow algorithm consists of two phases, this method runs
jacint@920
   217
    ///the first phase. After the first phase the maximum flow value
zsuzska@1285
   218
    ///and a minimum value cut can already be computed, although a
jacint@920
   219
    ///maximum flow is not yet obtained. So after calling this method
jacint@920
   220
    ///\ref flowValue returns the value of a maximum flow and \ref
jacint@920
   221
    ///minCut returns a minimum cut.
alpar@911
   222
    ///\warning \ref minCut(), \ref minMinCut() and \ref maxMinCut() do not
alpar@911
   223
    ///give minimum value cuts unless calling \ref phase2().
jacint@836
   224
    void phase1()
jacint@836
   225
    {
alpar@1222
   226
      int heur0=(int)(H0*_node_num);  //time while running 'bound decrease'
alpar@1222
   227
      int heur1=(int)(H1*_node_num);  //time while running 'highest label'
jacint@836
   228
      int heur=heur1;         //starting time interval (#of relabels)
jacint@836
   229
      int numrelabel=0;
jacint@836
   230
jacint@836
   231
      bool what_heur=1;
jacint@836
   232
      //It is 0 in case 'bound decrease' and 1 in case 'highest label'
jacint@836
   233
jacint@836
   234
      bool end=false;
jacint@836
   235
      //Needed for 'bound decrease', true means no active 
jacint@836
   236
      //nodes are above bound b.
jacint@836
   237
alpar@1222
   238
      int k=_node_num-2;  //bound on the highest level under n containing a node
jacint@836
   239
      int b=k;    //bound on the highest level under n of an active node
jacint@836
   240
alpar@1222
   241
      VecNode first(_node_num, INVALID);
alpar@1222
   242
      NNMap next(*_g, INVALID);
jacint@836
   243
alpar@1222
   244
      NNMap left(*_g, INVALID);
alpar@1222
   245
      NNMap right(*_g, INVALID);
alpar@1222
   246
      VecNode level_list(_node_num,INVALID);
jacint@836
   247
      //List of the nodes in level i<n, set to n.
jacint@836
   248
jacint@836
   249
      preflowPreproc(first, next, level_list, left, right);
jacint@836
   250
jacint@836
   251
      //Push/relabel on the highest level active nodes.
jacint@836
   252
      while ( true ) {
jacint@836
   253
	if ( b == 0 ) {
jacint@836
   254
	  if ( !what_heur && !end && k > 0 ) {
jacint@836
   255
	    b=k;
jacint@836
   256
	    end=true;
jacint@836
   257
	  } else break;
jacint@836
   258
	}
jacint@836
   259
jacint@836
   260
	if ( first[b]==INVALID ) --b;
jacint@836
   261
	else {
jacint@836
   262
	  end=false;
jacint@836
   263
	  Node w=first[b];
jacint@836
   264
	  first[b]=next[w];
jacint@836
   265
	  int newlevel=push(w, next, first);
jacint@836
   266
	  if ( excess[w] > 0 ) relabel(w, newlevel, first, next, level_list, 
jacint@836
   267
				       left, right, b, k, what_heur);
jacint@836
   268
jacint@836
   269
	  ++numrelabel;
jacint@836
   270
	  if ( numrelabel >= heur ) {
jacint@836
   271
	    numrelabel=0;
jacint@836
   272
	    if ( what_heur ) {
jacint@836
   273
	      what_heur=0;
jacint@836
   274
	      heur=heur0;
jacint@836
   275
	      end=false;
jacint@836
   276
	    } else {
jacint@836
   277
	      what_heur=1;
jacint@836
   278
	      heur=heur1;
jacint@836
   279
	      b=k;
jacint@836
   280
	    }
jacint@836
   281
	  }
jacint@836
   282
	}
jacint@836
   283
      }
jacint@836
   284
      flow_prop=PRE_FLOW;
jacint@836
   285
      status=AFTER_PREFLOW_PHASE_1;
jacint@836
   286
    }
jacint@836
   287
    // Heuristics:
jacint@836
   288
    //   2 phase
jacint@836
   289
    //   gap
jacint@836
   290
    //   list 'level_list' on the nodes on level i implemented by hand
jacint@836
   291
    //   stack 'active' on the active nodes on level i      
jacint@836
   292
    //   runs heuristic 'highest label' for H1*n relabels
alpar@1222
   293
    //   runs heuristic 'bound decrease' for H0*n relabels,
alpar@1222
   294
    //        starts with 'highest label'
jacint@836
   295
    //   Parameters H0 and H1 are initialized to 20 and 1.
jacint@836
   296
jacint@836
   297
jacint@836
   298
    ///Runs the second phase of the preflow algorithm.
jacint@836
   299
jacint@836
   300
    ///The preflow algorithm consists of two phases, this method runs
alpar@1631
   301
    ///the second phase. After calling \ref phase1() and then
alpar@1631
   302
    ///\ref phase2(),
alpar@1631
   303
    /// \ref flowMap() return a maximum flow, \ref flowValue
jacint@920
   304
    ///returns the value of a maximum flow, \ref minCut returns a
jacint@920
   305
    ///minimum cut, while the methods \ref minMinCut and \ref
jacint@920
   306
    ///maxMinCut return the inclusionwise minimum and maximum cuts of
jacint@920
   307
    ///minimum value, resp.  \pre \ref phase1 must be called before.
jacint@836
   308
    void phase2()
jacint@836
   309
    {
jacint@836
   310
alpar@1222
   311
      int k=_node_num-2;  //bound on the highest level under n containing a node
jacint@836
   312
      int b=k;    //bound on the highest level under n of an active node
jacint@836
   313
jacint@836
   314
    
alpar@1222
   315
      VecNode first(_node_num, INVALID);
alpar@1222
   316
      NNMap next(*_g, INVALID); 
alpar@1222
   317
      level.set(_source,0);
jacint@836
   318
      std::queue<Node> bfs_queue;
alpar@1222
   319
      bfs_queue.push(_source);
jacint@836
   320
jacint@836
   321
      while ( !bfs_queue.empty() ) {
jacint@836
   322
jacint@836
   323
	Node v=bfs_queue.front();
jacint@836
   324
	bfs_queue.pop();
jacint@836
   325
	int l=level[v]+1;
jacint@836
   326
alpar@1222
   327
	for(InEdgeIt e(*_g,v); e!=INVALID; ++e) {
alpar@1222
   328
	  if ( (*_capacity)[e] <= (*_flow)[e] ) continue;
alpar@1222
   329
	  Node u=_g->source(e);
alpar@1222
   330
	  if ( level[u] >= _node_num ) {
jacint@836
   331
	    bfs_queue.push(u);
jacint@836
   332
	    level.set(u, l);
jacint@836
   333
	    if ( excess[u] > 0 ) {
jacint@836
   334
	      next.set(u,first[l]);
jacint@836
   335
	      first[l]=u;
jacint@836
   336
	    }
jacint@836
   337
	  }
jacint@836
   338
	}
jacint@836
   339
alpar@1222
   340
	for(OutEdgeIt e(*_g,v); e!=INVALID; ++e) {
alpar@1222
   341
	  if ( 0 >= (*_flow)[e] ) continue;
alpar@1222
   342
	  Node u=_g->target(e);
alpar@1222
   343
	  if ( level[u] >= _node_num ) {
jacint@836
   344
	    bfs_queue.push(u);
jacint@836
   345
	    level.set(u, l);
jacint@836
   346
	    if ( excess[u] > 0 ) {
jacint@836
   347
	      next.set(u,first[l]);
jacint@836
   348
	      first[l]=u;
jacint@836
   349
	    }
jacint@836
   350
	  }
jacint@836
   351
	}
jacint@836
   352
      }
alpar@1222
   353
      b=_node_num-2;
jacint@836
   354
jacint@836
   355
      while ( true ) {
jacint@836
   356
jacint@836
   357
	if ( b == 0 ) break;
jacint@836
   358
	if ( first[b]==INVALID ) --b;
jacint@836
   359
	else {
jacint@836
   360
	  Node w=first[b];
jacint@836
   361
	  first[b]=next[w];
jacint@836
   362
	  int newlevel=push(w,next, first);
jacint@836
   363
	  
jacint@836
   364
	  //relabel
jacint@836
   365
	  if ( excess[w] > 0 ) {
jacint@836
   366
	    level.set(w,++newlevel);
jacint@836
   367
	    next.set(w,first[newlevel]);
jacint@836
   368
	    first[newlevel]=w;
jacint@836
   369
	    b=newlevel;
jacint@836
   370
	  }
jacint@836
   371
	} 
jacint@836
   372
      } // while(true)
jacint@836
   373
      flow_prop=GEN_FLOW;
jacint@836
   374
      status=AFTER_PREFLOW_PHASE_2;
jacint@836
   375
    }
jacint@836
   376
jacint@836
   377
    /// Returns the value of the maximum flow.
jacint@836
   378
jacint@836
   379
    /// Returns the value of the maximum flow by returning the excess
alpar@911
   380
    /// of the target node \c t. This value equals to the value of
jacint@836
   381
    /// the maximum flow already after running \ref phase1.
jacint@836
   382
    Num flowValue() const {
alpar@1222
   383
      return excess[_target];
jacint@836
   384
    }
jacint@836
   385
jacint@836
   386
jacint@836
   387
    ///Returns a minimum value cut.
jacint@836
   388
jacint@836
   389
    ///Sets \c M to the characteristic vector of a minimum value
jacint@836
   390
    ///cut. This method can be called both after running \ref
jacint@836
   391
    ///phase1 and \ref phase2. It is much faster after
marci@849
   392
    ///\ref phase1.  \pre M should be a bool-valued node-map. \pre
alpar@911
   393
    ///If \ref minCut() is called after \ref phase2() then M should
jacint@836
   394
    ///be initialized to false.
jacint@836
   395
    template<typename _CutMap>
jacint@836
   396
    void minCut(_CutMap& M) const {
jacint@836
   397
      switch ( status ) {
jacint@836
   398
	case AFTER_PREFLOW_PHASE_1:
alpar@1222
   399
	for(NodeIt v(*_g); v!=INVALID; ++v) {
alpar@1222
   400
	  if (level[v] < _node_num) {
jacint@836
   401
	    M.set(v, false);
jacint@836
   402
	  } else {
jacint@836
   403
	    M.set(v, true);
jacint@836
   404
	  }
jacint@836
   405
	}
jacint@836
   406
	break;
jacint@836
   407
	case AFTER_PREFLOW_PHASE_2:
jacint@836
   408
	minMinCut(M);
jacint@836
   409
	break;
jacint@836
   410
	case AFTER_NOTHING:
jacint@836
   411
	break;
jacint@836
   412
      }
jacint@836
   413
    }
jacint@836
   414
jacint@836
   415
    ///Returns the inclusionwise minimum of the minimum value cuts.
jacint@836
   416
jacint@836
   417
    ///Sets \c M to the characteristic vector of the minimum value cut
jacint@836
   418
    ///which is inclusionwise minimum. It is computed by processing a
jacint@836
   419
    ///bfs from the source node \c s in the residual graph.  \pre M
jacint@836
   420
    ///should be a node map of bools initialized to false.  \pre \ref
jacint@836
   421
    ///phase2 should already be run.
jacint@836
   422
    template<typename _CutMap>
jacint@836
   423
    void minMinCut(_CutMap& M) const {
jacint@836
   424
jacint@836
   425
      std::queue<Node> queue;
alpar@1222
   426
      M.set(_source,true);
alpar@1227
   427
      queue.push(_source);
jacint@836
   428
      
jacint@836
   429
      while (!queue.empty()) {
jacint@836
   430
	Node w=queue.front();
jacint@836
   431
	queue.pop();
jacint@836
   432
	
alpar@1222
   433
	for(OutEdgeIt e(*_g,w) ; e!=INVALID; ++e) {
alpar@1222
   434
	  Node v=_g->target(e);
alpar@1222
   435
	  if (!M[v] && (*_flow)[e] < (*_capacity)[e] ) {
jacint@836
   436
	    queue.push(v);
jacint@836
   437
	    M.set(v, true);
jacint@836
   438
	  }
jacint@836
   439
	}
jacint@836
   440
	
alpar@1222
   441
	for(InEdgeIt e(*_g,w) ; e!=INVALID; ++e) {
alpar@1222
   442
	  Node v=_g->source(e);
alpar@1222
   443
	  if (!M[v] && (*_flow)[e] > 0 ) {
jacint@836
   444
	    queue.push(v);
jacint@836
   445
	    M.set(v, true);
jacint@836
   446
	  }
jacint@836
   447
	}
jacint@836
   448
      }
jacint@836
   449
    }
jacint@836
   450
    
jacint@836
   451
    ///Returns the inclusionwise maximum of the minimum value cuts.
jacint@836
   452
jacint@836
   453
    ///Sets \c M to the characteristic vector of the minimum value cut
jacint@836
   454
    ///which is inclusionwise maximum. It is computed by processing a
jacint@836
   455
    ///backward bfs from the target node \c t in the residual graph.
alpar@911
   456
    ///\pre \ref phase2() or run() should already be run.
jacint@836
   457
    template<typename _CutMap>
jacint@836
   458
    void maxMinCut(_CutMap& M) const {
jacint@836
   459
alpar@1222
   460
      for(NodeIt v(*_g) ; v!=INVALID; ++v) M.set(v, true);
jacint@836
   461
jacint@836
   462
      std::queue<Node> queue;
jacint@836
   463
alpar@1222
   464
      M.set(_target,false);
alpar@1222
   465
      queue.push(_target);
jacint@836
   466
jacint@836
   467
      while (!queue.empty()) {
jacint@836
   468
        Node w=queue.front();
jacint@836
   469
	queue.pop();
jacint@836
   470
alpar@1222
   471
	for(InEdgeIt e(*_g,w) ; e!=INVALID; ++e) {
alpar@1222
   472
	  Node v=_g->source(e);
alpar@1222
   473
	  if (M[v] && (*_flow)[e] < (*_capacity)[e] ) {
jacint@836
   474
	    queue.push(v);
jacint@836
   475
	    M.set(v, false);
jacint@836
   476
	  }
jacint@836
   477
	}
jacint@836
   478
alpar@1222
   479
	for(OutEdgeIt e(*_g,w) ; e!=INVALID; ++e) {
alpar@1222
   480
	  Node v=_g->target(e);
alpar@1222
   481
	  if (M[v] && (*_flow)[e] > 0 ) {
jacint@836
   482
	    queue.push(v);
jacint@836
   483
	    M.set(v, false);
jacint@836
   484
	  }
jacint@836
   485
	}
jacint@836
   486
      }
jacint@836
   487
    }
jacint@836
   488
jacint@836
   489
    ///Sets the source node to \c _s.
jacint@836
   490
jacint@836
   491
    ///Sets the source node to \c _s.
jacint@836
   492
    /// 
alpar@1222
   493
    void source(Node _s) { 
alpar@1222
   494
      _source=_s; 
jacint@836
   495
      if ( flow_prop != ZERO_FLOW ) flow_prop=NO_FLOW;
jacint@836
   496
      status=AFTER_NOTHING; 
jacint@836
   497
    }
jacint@836
   498
alpar@1222
   499
    ///Returns the source node.
alpar@1222
   500
alpar@1222
   501
    ///Returns the source node.
alpar@1222
   502
    /// 
alpar@1222
   503
    Node source() const { 
alpar@1222
   504
      return _source;
alpar@1222
   505
    }
alpar@1222
   506
jacint@836
   507
    ///Sets the target node to \c _t.
jacint@836
   508
jacint@836
   509
    ///Sets the target node to \c _t.
jacint@836
   510
    ///
alpar@1222
   511
    void target(Node _t) { 
alpar@1222
   512
      _target=_t; 
jacint@836
   513
      if ( flow_prop == GEN_FLOW ) flow_prop=PRE_FLOW;
jacint@836
   514
      status=AFTER_NOTHING; 
jacint@836
   515
    }
jacint@836
   516
alpar@1222
   517
    ///Returns the target node.
alpar@1222
   518
alpar@1222
   519
    ///Returns the target node.
alpar@1222
   520
    /// 
alpar@1222
   521
    Node target() const { 
alpar@1222
   522
      return _target;
alpar@1222
   523
    }
alpar@1222
   524
jacint@836
   525
    /// Sets the edge map of the capacities to _cap.
jacint@836
   526
jacint@836
   527
    /// Sets the edge map of the capacities to _cap.
jacint@836
   528
    /// 
alpar@1222
   529
    void capacityMap(const CapacityMap& _cap) { 
alpar@1222
   530
      _capacity=&_cap; 
jacint@836
   531
      status=AFTER_NOTHING; 
jacint@836
   532
    }
zsuzska@1285
   533
    /// Returns a reference to capacity map.
alpar@1222
   534
zsuzska@1285
   535
    /// Returns a reference to capacity map.
alpar@1222
   536
    /// 
alpar@1222
   537
    const CapacityMap &capacityMap() const { 
alpar@1222
   538
      return *_capacity;
alpar@1222
   539
    }
jacint@836
   540
jacint@836
   541
    /// Sets the edge map of the flows to _flow.
jacint@836
   542
jacint@836
   543
    /// Sets the edge map of the flows to _flow.
jacint@836
   544
    /// 
alpar@1222
   545
    void flowMap(FlowMap& _f) { 
alpar@1222
   546
      _flow=&_f; 
jacint@836
   547
      flow_prop=NO_FLOW;
jacint@836
   548
      status=AFTER_NOTHING; 
jacint@836
   549
    }
alpar@1222
   550
     
zsuzska@1285
   551
    /// Returns a reference to flow map.
jacint@836
   552
zsuzska@1285
   553
    /// Returns a reference to flow map.
alpar@1222
   554
    /// 
alpar@1222
   555
    const FlowMap &flowMap() const { 
alpar@1222
   556
      return *_flow;
alpar@1222
   557
    }
jacint@836
   558
jacint@836
   559
  private:
jacint@836
   560
jacint@836
   561
    int push(Node w, NNMap& next, VecNode& first) {
jacint@836
   562
jacint@836
   563
      int lev=level[w];
jacint@836
   564
      Num exc=excess[w];
alpar@1222
   565
      int newlevel=_node_num;       //bound on the next level of w
jacint@836
   566
alpar@1222
   567
      for(OutEdgeIt e(*_g,w) ; e!=INVALID; ++e) {
alpar@1222
   568
	if ( (*_flow)[e] >= (*_capacity)[e] ) continue;
alpar@1222
   569
	Node v=_g->target(e);
jacint@836
   570
jacint@836
   571
	if( lev > level[v] ) { //Push is allowed now
jacint@836
   572
	  
alpar@1222
   573
	  if ( excess[v]<=0 && v!=_target && v!=_source ) {
jacint@836
   574
	    next.set(v,first[level[v]]);
jacint@836
   575
	    first[level[v]]=v;
jacint@836
   576
	  }
jacint@836
   577
alpar@1222
   578
	  Num cap=(*_capacity)[e];
alpar@1222
   579
	  Num flo=(*_flow)[e];
jacint@836
   580
	  Num remcap=cap-flo;
jacint@836
   581
	  
jacint@836
   582
	  if ( remcap >= exc ) { //A nonsaturating push.
jacint@836
   583
	    
alpar@1222
   584
	    _flow->set(e, flo+exc);
jacint@836
   585
	    excess.set(v, excess[v]+exc);
jacint@836
   586
	    exc=0;
jacint@836
   587
	    break;
jacint@836
   588
jacint@836
   589
	  } else { //A saturating push.
alpar@1222
   590
	    _flow->set(e, cap);
jacint@836
   591
	    excess.set(v, excess[v]+remcap);
jacint@836
   592
	    exc-=remcap;
jacint@836
   593
	  }
jacint@836
   594
	} else if ( newlevel > level[v] ) newlevel = level[v];
jacint@836
   595
      } //for out edges wv
jacint@836
   596
jacint@836
   597
      if ( exc > 0 ) {
alpar@1222
   598
	for(InEdgeIt e(*_g,w) ; e!=INVALID; ++e) {
jacint@836
   599
	  
alpar@1222
   600
	  if( (*_flow)[e] <= 0 ) continue;
alpar@1222
   601
	  Node v=_g->source(e);
jacint@836
   602
jacint@836
   603
	  if( lev > level[v] ) { //Push is allowed now
jacint@836
   604
alpar@1222
   605
	    if ( excess[v]<=0 && v!=_target && v!=_source ) {
jacint@836
   606
	      next.set(v,first[level[v]]);
jacint@836
   607
	      first[level[v]]=v;
jacint@836
   608
	    }
jacint@836
   609
alpar@1222
   610
	    Num flo=(*_flow)[e];
jacint@836
   611
jacint@836
   612
	    if ( flo >= exc ) { //A nonsaturating push.
jacint@836
   613
alpar@1222
   614
	      _flow->set(e, flo-exc);
jacint@836
   615
	      excess.set(v, excess[v]+exc);
jacint@836
   616
	      exc=0;
jacint@836
   617
	      break;
jacint@836
   618
	    } else {  //A saturating push.
jacint@836
   619
jacint@836
   620
	      excess.set(v, excess[v]+flo);
jacint@836
   621
	      exc-=flo;
alpar@1222
   622
	      _flow->set(e,0);
jacint@836
   623
	    }
jacint@836
   624
	  } else if ( newlevel > level[v] ) newlevel = level[v];
jacint@836
   625
	} //for in edges vw
jacint@836
   626
jacint@836
   627
      } // if w still has excess after the out edge for cycle
jacint@836
   628
jacint@836
   629
      excess.set(w, exc);
jacint@836
   630
      
jacint@836
   631
      return newlevel;
jacint@836
   632
    }
jacint@836
   633
    
jacint@836
   634
    
jacint@836
   635
    
jacint@836
   636
    void preflowPreproc(VecNode& first, NNMap& next, 
jacint@836
   637
			VecNode& level_list, NNMap& left, NNMap& right)
jacint@836
   638
    {
alpar@1222
   639
      for(NodeIt v(*_g); v!=INVALID; ++v) level.set(v,_node_num);
jacint@836
   640
      std::queue<Node> bfs_queue;
jacint@836
   641
      
jacint@836
   642
      if ( flow_prop == GEN_FLOW || flow_prop == PRE_FLOW ) {
jacint@836
   643
	//Reverse_bfs from t in the residual graph,
jacint@836
   644
	//to find the starting level.
alpar@1222
   645
	level.set(_target,0);
alpar@1222
   646
	bfs_queue.push(_target);
jacint@836
   647
	
jacint@836
   648
	while ( !bfs_queue.empty() ) {
jacint@836
   649
	  
jacint@836
   650
	  Node v=bfs_queue.front();
jacint@836
   651
	  bfs_queue.pop();
jacint@836
   652
	  int l=level[v]+1;
jacint@836
   653
	  
alpar@1222
   654
	  for(InEdgeIt e(*_g,v) ; e!=INVALID; ++e) {
alpar@1222
   655
	    if ( (*_capacity)[e] <= (*_flow)[e] ) continue;
alpar@1222
   656
	    Node w=_g->source(e);
alpar@1222
   657
	    if ( level[w] == _node_num && w != _source ) {
jacint@836
   658
	      bfs_queue.push(w);
jacint@836
   659
	      Node z=level_list[l];
jacint@836
   660
	      if ( z!=INVALID ) left.set(z,w);
jacint@836
   661
	      right.set(w,z);
jacint@836
   662
	      level_list[l]=w;
jacint@836
   663
	      level.set(w, l);
jacint@836
   664
	    }
jacint@836
   665
	  }
jacint@836
   666
	  
alpar@1222
   667
	  for(OutEdgeIt e(*_g,v) ; e!=INVALID; ++e) {
alpar@1222
   668
	    if ( 0 >= (*_flow)[e] ) continue;
alpar@1222
   669
	    Node w=_g->target(e);
alpar@1222
   670
	    if ( level[w] == _node_num && w != _source ) {
jacint@836
   671
	      bfs_queue.push(w);
jacint@836
   672
	      Node z=level_list[l];
jacint@836
   673
	      if ( z!=INVALID ) left.set(z,w);
jacint@836
   674
	      right.set(w,z);
jacint@836
   675
	      level_list[l]=w;
jacint@836
   676
	      level.set(w, l);
jacint@836
   677
	    }
jacint@836
   678
	  }
jacint@836
   679
	} //while
jacint@836
   680
      } //if
jacint@836
   681
jacint@836
   682
jacint@836
   683
      switch (flow_prop) {
jacint@836
   684
	case NO_FLOW:  
alpar@1222
   685
	for(EdgeIt e(*_g); e!=INVALID; ++e) _flow->set(e,0);
jacint@836
   686
	case ZERO_FLOW:
alpar@1222
   687
	for(NodeIt v(*_g); v!=INVALID; ++v) excess.set(v,0);
jacint@836
   688
	
jacint@836
   689
	//Reverse_bfs from t, to find the starting level.
alpar@1222
   690
	level.set(_target,0);
alpar@1222
   691
	bfs_queue.push(_target);
jacint@836
   692
	
jacint@836
   693
	while ( !bfs_queue.empty() ) {
jacint@836
   694
	  
jacint@836
   695
	  Node v=bfs_queue.front();
jacint@836
   696
	  bfs_queue.pop();
jacint@836
   697
	  int l=level[v]+1;
jacint@836
   698
	  
alpar@1222
   699
	  for(InEdgeIt e(*_g,v) ; e!=INVALID; ++e) {
alpar@1222
   700
	    Node w=_g->source(e);
alpar@1222
   701
	    if ( level[w] == _node_num && w != _source ) {
jacint@836
   702
	      bfs_queue.push(w);
jacint@836
   703
	      Node z=level_list[l];
jacint@836
   704
	      if ( z!=INVALID ) left.set(z,w);
jacint@836
   705
	      right.set(w,z);
jacint@836
   706
	      level_list[l]=w;
jacint@836
   707
	      level.set(w, l);
jacint@836
   708
	    }
jacint@836
   709
	  }
jacint@836
   710
	}
jacint@836
   711
	
jacint@836
   712
	//the starting flow
alpar@1222
   713
	for(OutEdgeIt e(*_g,_source) ; e!=INVALID; ++e) {
alpar@1222
   714
	  Num c=(*_capacity)[e];
jacint@836
   715
	  if ( c <= 0 ) continue;
alpar@1222
   716
	  Node w=_g->target(e);
alpar@1222
   717
	  if ( level[w] < _node_num ) {
alpar@1222
   718
	    if ( excess[w] <= 0 && w!=_target ) { //putting into the stack
jacint@836
   719
	      next.set(w,first[level[w]]);
jacint@836
   720
	      first[level[w]]=w;
jacint@836
   721
	    }
alpar@1222
   722
	    _flow->set(e, c);
jacint@836
   723
	    excess.set(w, excess[w]+c);
jacint@836
   724
	  }
jacint@836
   725
	}
jacint@836
   726
	break;
jacint@836
   727
jacint@836
   728
	case GEN_FLOW:
alpar@1222
   729
	for(NodeIt v(*_g); v!=INVALID; ++v) excess.set(v,0);
jacint@836
   730
	{
jacint@836
   731
	  Num exc=0;
alpar@1222
   732
	  for(InEdgeIt e(*_g,_target) ; e!=INVALID; ++e) exc+=(*_flow)[e];
alpar@1222
   733
	  for(OutEdgeIt e(*_g,_target) ; e!=INVALID; ++e) exc-=(*_flow)[e];
alpar@1222
   734
	  excess.set(_target,exc);
jacint@836
   735
	}
jacint@836
   736
jacint@836
   737
	//the starting flow
alpar@1222
   738
	for(OutEdgeIt e(*_g,_source); e!=INVALID; ++e)	{
alpar@1222
   739
	  Num rem=(*_capacity)[e]-(*_flow)[e];
jacint@836
   740
	  if ( rem <= 0 ) continue;
alpar@1222
   741
	  Node w=_g->target(e);
alpar@1222
   742
	  if ( level[w] < _node_num ) {
alpar@1222
   743
	    if ( excess[w] <= 0 && w!=_target ) { //putting into the stack
jacint@836
   744
	      next.set(w,first[level[w]]);
jacint@836
   745
	      first[level[w]]=w;
jacint@836
   746
	    }   
alpar@1222
   747
	    _flow->set(e, (*_capacity)[e]);
jacint@836
   748
	    excess.set(w, excess[w]+rem);
jacint@836
   749
	  }
jacint@836
   750
	}
jacint@836
   751
	
alpar@1222
   752
	for(InEdgeIt e(*_g,_source); e!=INVALID; ++e) {
alpar@1222
   753
	  if ( (*_flow)[e] <= 0 ) continue;
alpar@1222
   754
	  Node w=_g->source(e);
alpar@1222
   755
	  if ( level[w] < _node_num ) {
alpar@1222
   756
	    if ( excess[w] <= 0 && w!=_target ) {
jacint@836
   757
	      next.set(w,first[level[w]]);
jacint@836
   758
	      first[level[w]]=w;
jacint@836
   759
	    }  
alpar@1222
   760
	    excess.set(w, excess[w]+(*_flow)[e]);
alpar@1222
   761
	    _flow->set(e, 0);
jacint@836
   762
	  }
jacint@836
   763
	}
jacint@836
   764
	break;
jacint@836
   765
jacint@836
   766
	case PRE_FLOW:	
jacint@836
   767
	//the starting flow
alpar@1222
   768
	for(OutEdgeIt e(*_g,_source) ; e!=INVALID; ++e) {
alpar@1222
   769
	  Num rem=(*_capacity)[e]-(*_flow)[e];
jacint@836
   770
	  if ( rem <= 0 ) continue;
alpar@1222
   771
	  Node w=_g->target(e);
alpar@1222
   772
	  if ( level[w] < _node_num ) _flow->set(e, (*_capacity)[e]);
jacint@836
   773
	}
jacint@836
   774
	
alpar@1222
   775
	for(InEdgeIt e(*_g,_source) ; e!=INVALID; ++e) {
alpar@1222
   776
	  if ( (*_flow)[e] <= 0 ) continue;
alpar@1222
   777
	  Node w=_g->source(e);
alpar@1222
   778
	  if ( level[w] < _node_num ) _flow->set(e, 0);
jacint@836
   779
	}
jacint@836
   780
	
jacint@836
   781
	//computing the excess
alpar@1222
   782
	for(NodeIt w(*_g); w!=INVALID; ++w) {
jacint@836
   783
	  Num exc=0;
alpar@1222
   784
	  for(InEdgeIt e(*_g,w); e!=INVALID; ++e) exc+=(*_flow)[e];
alpar@1222
   785
	  for(OutEdgeIt e(*_g,w); e!=INVALID; ++e) exc-=(*_flow)[e];
jacint@836
   786
	  excess.set(w,exc);
jacint@836
   787
	  
jacint@836
   788
	  //putting the active nodes into the stack
jacint@836
   789
	  int lev=level[w];
alpar@1222
   790
	    if ( exc > 0 && lev < _node_num && Node(w) != _target ) {
jacint@836
   791
	      next.set(w,first[lev]);
jacint@836
   792
	      first[lev]=w;
jacint@836
   793
	    }
jacint@836
   794
	}
jacint@836
   795
	break;
jacint@836
   796
      } //switch
jacint@836
   797
    } //preflowPreproc
jacint@836
   798
jacint@836
   799
jacint@836
   800
    void relabel(Node w, int newlevel, VecNode& first, NNMap& next, 
jacint@836
   801
		 VecNode& level_list, NNMap& left,
jacint@836
   802
		 NNMap& right, int& b, int& k, bool what_heur )
jacint@836
   803
    {
jacint@836
   804
jacint@836
   805
      int lev=level[w];
jacint@836
   806
jacint@836
   807
      Node right_n=right[w];
jacint@836
   808
      Node left_n=left[w];
jacint@836
   809
jacint@836
   810
      //unlacing starts
jacint@836
   811
      if ( right_n!=INVALID ) {
jacint@836
   812
	if ( left_n!=INVALID ) {
jacint@836
   813
	  right.set(left_n, right_n);
jacint@836
   814
	  left.set(right_n, left_n);
jacint@836
   815
	} else {
jacint@836
   816
	  level_list[lev]=right_n;
jacint@836
   817
	  left.set(right_n, INVALID);
jacint@836
   818
	}
jacint@836
   819
      } else {
jacint@836
   820
	if ( left_n!=INVALID ) {
jacint@836
   821
	  right.set(left_n, INVALID);
jacint@836
   822
	} else {
jacint@836
   823
	  level_list[lev]=INVALID;
jacint@836
   824
	}
jacint@836
   825
      }
jacint@836
   826
      //unlacing ends
jacint@836
   827
jacint@836
   828
      if ( level_list[lev]==INVALID ) {
jacint@836
   829
jacint@836
   830
	//gapping starts
jacint@836
   831
	for (int i=lev; i!=k ; ) {
jacint@836
   832
	  Node v=level_list[++i];
jacint@836
   833
	  while ( v!=INVALID ) {
alpar@1222
   834
	    level.set(v,_node_num);
jacint@836
   835
	    v=right[v];
jacint@836
   836
	  }
jacint@836
   837
	  level_list[i]=INVALID;
jacint@836
   838
	  if ( !what_heur ) first[i]=INVALID;
jacint@836
   839
	}
jacint@836
   840
alpar@1222
   841
	level.set(w,_node_num);
jacint@836
   842
	b=lev-1;
jacint@836
   843
	k=b;
jacint@836
   844
	//gapping ends
jacint@836
   845
jacint@836
   846
      } else {
jacint@836
   847
alpar@1222
   848
	if ( newlevel == _node_num ) level.set(w,_node_num);
jacint@836
   849
	else {
jacint@836
   850
	  level.set(w,++newlevel);
jacint@836
   851
	  next.set(w,first[newlevel]);
jacint@836
   852
	  first[newlevel]=w;
jacint@836
   853
	  if ( what_heur ) b=newlevel;
jacint@836
   854
	  if ( k < newlevel ) ++k;      //now k=newlevel
jacint@836
   855
	  Node z=level_list[newlevel];
jacint@836
   856
	  if ( z!=INVALID ) left.set(z,w);
jacint@836
   857
	  right.set(w,z);
jacint@836
   858
	  left.set(w,INVALID);
jacint@836
   859
	  level_list[newlevel]=w;
jacint@836
   860
	}
jacint@836
   861
      }
jacint@836
   862
    } //relabel
jacint@836
   863
jacint@836
   864
  }; 
alpar@1227
   865
alpar@1227
   866
  ///Function type interface for Preflow algorithm.
alpar@1227
   867
alpar@1227
   868
  /// \ingroup flowalgs
alpar@1227
   869
  ///Function type interface for Preflow algorithm.
alpar@1227
   870
  ///\sa Preflow
alpar@1227
   871
  template<class GR, class CM, class FM>
alpar@1227
   872
  Preflow<GR,typename CM::Value,CM,FM> preflow(const GR &g,
alpar@1227
   873
			    typename GR::Node source,
alpar@1227
   874
			    typename GR::Node target,
alpar@1227
   875
			    const CM &cap,
alpar@1227
   876
			    FM &flow
alpar@1227
   877
			    )
alpar@1227
   878
  {
alpar@1227
   879
    return Preflow<GR,typename CM::Value,CM,FM>(g,source,target,cap,flow);
alpar@1227
   880
  }
alpar@1227
   881
alpar@921
   882
} //namespace lemon
jacint@836
   883
alpar@921
   884
#endif //LEMON_PREFLOW_H