src/hugo/preflow.h
changeset 851 209c9d53e195
parent 849 cc3867a7d380
child 874 2195bc090dfe
     1.1 --- a/src/hugo/preflow.h	Tue Sep 14 10:23:26 2004 +0000
     1.2 +++ b/src/hugo/preflow.h	Tue Sep 14 10:29:47 2004 +0000
     1.3 @@ -16,22 +16,22 @@
     1.4    /// \addtogroup flowalgs
     1.5    /// @{                                                   
     1.6  
     1.7 -  ///Preflow algorithms class.
     1.8 +  ///%Preflow algorithms class.
     1.9  
    1.10    ///This class provides an implementation of the \e preflow \e
    1.11    ///algorithm producing a flow of maximum value in a directed
    1.12    ///graph. The preflow algorithms are the fastest max flow algorithms
    1.13 -  ///up-to-date. The \e source node, the \e target node, the \e
    1.14 +  ///up to now. The \e source node, the \e target node, the \e
    1.15    ///capacity of the edges and the \e starting \e flow value of the
    1.16    ///edges should be passed to the algorithm through the
    1.17    ///constructor. It is possible to change these quantities using the
    1.18    ///functions \ref setSource, \ref setTarget, \ref setCap and \ref
    1.19    ///setFlow.
    1.20    ///
    1.21 -  ///After running \c phase1 or \c preflow, the actual flow
    1.22 +  ///After running \ref phase1() or \ref preflow(), the actual flow
    1.23    ///value can be obtained by calling \ref flowValue(). The minimum
    1.24 -  ///value cut can be written into a \c node map of \c bools by
    1.25 -  ///calling \ref minCut. (\ref minMinCut and \ref maxMinCut writes
    1.26 +  ///value cut can be written into a <tt>bool</tt> node map by
    1.27 +  ///calling \ref minCut(). (\ref minMinCut() and \ref maxMinCut() writes
    1.28    ///the inclusionwise minimum and maximum of the minimum value cuts,
    1.29    ///resp.)
    1.30    ///
    1.31 @@ -129,7 +129,8 @@
    1.32                                                                                
    1.33      ///Runs the preflow algorithm.  
    1.34  
    1.35 -    ///Runs the preflow algorithm. 
    1.36 +    ///Runs the preflow algorithm.
    1.37 +    ///
    1.38      void run() {
    1.39        phase1(flow_prop);
    1.40        phase2();
    1.41 @@ -157,7 +158,7 @@
    1.42      ///minimum value cut can already be computed, though a maximum flow
    1.43      ///is not yet obtained. So after calling this method \ref flowValue
    1.44      ///and \ref minCut gives proper results.
    1.45 -    ///\warning: \ref minMinCut and \ref maxMinCut do not
    1.46 +    ///\warning \ref minMinCut and \ref maxMinCut do not
    1.47      ///give minimum value cuts unless calling \ref phase2.
    1.48      ///\pre The starting flow must be
    1.49      /// - a constant zero flow if \c fp is \c ZERO_FLOW,
    1.50 @@ -178,7 +179,7 @@
    1.51      ///minimum value cut can already be computed, though a maximum flow
    1.52      ///is not yet obtained. So after calling this method \ref flowValue
    1.53      ///and \ref actMinCut gives proper results.
    1.54 -    ///\warning: \ref minCut, \ref minMinCut and \ref maxMinCut do not
    1.55 +    ///\warning \ref minCut, \ref minMinCut and \ref maxMinCut do not
    1.56      ///give minimum value cuts unless calling \ref phase2.
    1.57      void phase1()
    1.58      {