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