some changes in the doc to make things clearer
authorjacint
Wed, 29 Sep 2004 14:12:26 +0000
changeset 9202d6c8075d9d0
parent 919 6153d9cf78c6
child 921 818510fa3d99
some changes in the doc to make things clearer
src/hugo/preflow.h
     1.1 --- a/src/hugo/preflow.h	Wed Sep 29 14:02:14 2004 +0000
     1.2 +++ b/src/hugo/preflow.h	Wed Sep 29 14:12:26 2004 +0000
     1.3 @@ -45,7 +45,7 @@
     1.4    ///setFlow.
     1.5    ///
     1.6    ///After running \ref hugo::Preflow::phase1() "phase1()"
     1.7 -  ///or \ref hugo::Preflow::run() "run()", the actual flow
     1.8 +  ///or \ref hugo::Preflow::run() "run()", the maximal flow
     1.9    ///value can be obtained by calling \ref flowValue(). The minimum
    1.10    ///value cut can be written into a <tt>bool</tt> node map by
    1.11    ///calling \ref minCut(). (\ref minMinCut() and \ref maxMinCut() writes
    1.12 @@ -171,18 +171,19 @@
    1.13        
    1.14      ///Runs the first phase of the preflow algorithm.
    1.15  
    1.16 -    ///The preflow algorithm consists of two phases, this method runs the
    1.17 -    ///first phase. After the first phase the maximum flow value and a
    1.18 -    ///minimum value cut can already be computed, though a maximum flow
    1.19 -    ///is not yet obtained. So after calling this method \ref flowValue
    1.20 -    ///and \ref minCut gives proper results.
    1.21 -    ///\warning \ref minMinCut and \ref maxMinCut do not
    1.22 -    ///give minimum value cuts unless calling \ref phase2.
    1.23 -    ///\pre The starting flow must be
    1.24 -    /// - a constant zero flow if \c fp is \c ZERO_FLOW,
    1.25 -    /// - an arbitary flow if \c fp is \c GEN_FLOW,
    1.26 -    /// - an arbitary preflow if \c fp is \c PRE_FLOW,
    1.27 -    /// - any map if \c fp is NO_FLOW.
    1.28 +    ///The preflow algorithm consists of two phases, this method runs
    1.29 +    ///the first phase. After the first phase the maximum flow value
    1.30 +    ///and a minimum value cut can already be computed, though a
    1.31 +    ///maximum flow is not yet obtained. So after calling this method
    1.32 +    ///\ref flowValue returns the value of a maximum flow and \ref
    1.33 +    ///minCut returns a minimum cut.     
    1.34 +    ///\warning \ref minMinCut and \ref maxMinCut do not give minimum
    1.35 +    ///value cuts unless calling \ref phase2.  
    1.36 +    ///\pre The starting flow must be 
    1.37 +    ///- a constant zero flow if \c fp is \c ZERO_FLOW, 
    1.38 +    ///- an arbitary flow if \c fp is \c GEN_FLOW, 
    1.39 +    ///- an arbitary preflow if \c fp is \c PRE_FLOW, 
    1.40 +    ///- any map if \c fp is NO_FLOW.
    1.41      void phase1(FlowEnum fp)
    1.42      {
    1.43        flow_prop=fp;
    1.44 @@ -192,11 +193,12 @@
    1.45      
    1.46      ///Runs the first phase of the preflow algorithm.
    1.47  
    1.48 -    ///The preflow algorithm consists of two phases, this method runs the
    1.49 -    ///first phase. After the first phase the maximum flow value and a
    1.50 -    ///minimum value cut can already be computed, though a maximum flow
    1.51 -    ///is not yet obtained. So after calling this method \ref flowValue
    1.52 -    ///and \ref MinCut() gives proper results.
    1.53 +    ///The preflow algorithm consists of two phases, this method runs
    1.54 +    ///the first phase. After the first phase the maximum flow value
    1.55 +    ///and a minimum value cut can already be computed, though a
    1.56 +    ///maximum flow is not yet obtained. So after calling this method
    1.57 +    ///\ref flowValue returns the value of a maximum flow and \ref
    1.58 +    ///minCut returns a minimum cut.
    1.59      ///\warning \ref minCut(), \ref minMinCut() and \ref maxMinCut() do not
    1.60      ///give minimum value cuts unless calling \ref phase2().
    1.61      void phase1()
    1.62 @@ -275,10 +277,12 @@
    1.63      ///Runs the second phase of the preflow algorithm.
    1.64  
    1.65      ///The preflow algorithm consists of two phases, this method runs
    1.66 -    ///the second phase. After calling \ref phase1 and then
    1.67 -    ///\ref phase2 the methods \ref flowValue, \ref minCut,
    1.68 -    ///\ref minMinCut and \ref maxMinCut give proper results.
    1.69 -    ///\pre \ref phase1 must be called before.
    1.70 +    ///the second phase. After calling \ref phase1 and then \ref
    1.71 +    ///phase2, \ref flow contains a maximum flow, \ref flowValue
    1.72 +    ///returns the value of a maximum flow, \ref minCut returns a
    1.73 +    ///minimum cut, while the methods \ref minMinCut and \ref
    1.74 +    ///maxMinCut return the inclusionwise minimum and maximum cuts of
    1.75 +    ///minimum value, resp.  \pre \ref phase1 must be called before.
    1.76      void phase2()
    1.77      {
    1.78