COIN-OR::LEMON - Graph Library

Changeset 920:2d6c8075d9d0 in lemon-0.x


Ignore:
Timestamp:
09/29/04 16:12:26 (15 years ago)
Author:
jacint
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1231
Message:

some changes in the doc to make things clearer

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/hugo/preflow.h

    r911 r920  
    4646  ///
    4747  ///After running \ref hugo::Preflow::phase1() "phase1()"
    48   ///or \ref hugo::Preflow::run() "run()", the actual flow
     48  ///or \ref hugo::Preflow::run() "run()", the maximal flow
    4949  ///value can be obtained by calling \ref flowValue(). The minimum
    5050  ///value cut can be written into a <tt>bool</tt> node map by
     
    172172    ///Runs the first phase of the preflow algorithm.
    173173
    174     ///The preflow algorithm consists of two phases, this method runs the
    175     ///first phase. After the first phase the maximum flow value and a
    176     ///minimum value cut can already be computed, though a maximum flow
    177     ///is not yet obtained. So after calling this method \ref flowValue
    178     ///and \ref minCut gives proper results.
    179     ///\warning \ref minMinCut and \ref maxMinCut do not
    180     ///give minimum value cuts unless calling \ref phase2.
    181     ///\pre The starting flow must be
    182     /// - a constant zero flow if \c fp is \c ZERO_FLOW,
    183     /// - an arbitary flow if \c fp is \c GEN_FLOW,
    184     /// - an arbitary preflow if \c fp is \c PRE_FLOW,
    185     /// - any map if \c fp is NO_FLOW.
     174    ///The preflow algorithm consists of two phases, this method runs
     175    ///the first phase. After the first phase the maximum flow value
     176    ///and a minimum value cut can already be computed, though a
     177    ///maximum flow is not yet obtained. So after calling this method
     178    ///\ref flowValue returns the value of a maximum flow and \ref
     179    ///minCut returns a minimum cut.     
     180    ///\warning \ref minMinCut and \ref maxMinCut do not give minimum
     181    ///value cuts unless calling \ref phase2. 
     182    ///\pre The starting flow must be
     183    ///- a constant zero flow if \c fp is \c ZERO_FLOW,
     184    ///- an arbitary flow if \c fp is \c GEN_FLOW,
     185    ///- an arbitary preflow if \c fp is \c PRE_FLOW,
     186    ///- any map if \c fp is NO_FLOW.
    186187    void phase1(FlowEnum fp)
    187188    {
     
    193194    ///Runs the first phase of the preflow algorithm.
    194195
    195     ///The preflow algorithm consists of two phases, this method runs the
    196     ///first phase. After the first phase the maximum flow value and a
    197     ///minimum value cut can already be computed, though a maximum flow
    198     ///is not yet obtained. So after calling this method \ref flowValue
    199     ///and \ref MinCut() gives proper results.
     196    ///The preflow algorithm consists of two phases, this method runs
     197    ///the first phase. After the first phase the maximum flow value
     198    ///and a minimum value cut can already be computed, though a
     199    ///maximum flow is not yet obtained. So after calling this method
     200    ///\ref flowValue returns the value of a maximum flow and \ref
     201    ///minCut returns a minimum cut.
    200202    ///\warning \ref minCut(), \ref minMinCut() and \ref maxMinCut() do not
    201203    ///give minimum value cuts unless calling \ref phase2().
     
    276278
    277279    ///The preflow algorithm consists of two phases, this method runs
    278     ///the second phase. After calling \ref phase1 and then
    279     ///\ref phase2 the methods \ref flowValue, \ref minCut,
    280     ///\ref minMinCut and \ref maxMinCut give proper results.
    281     ///\pre \ref phase1 must be called before.
     280    ///the second phase. After calling \ref phase1 and then \ref
     281    ///phase2, \ref flow contains a maximum flow, \ref flowValue
     282    ///returns the value of a maximum flow, \ref minCut returns a
     283    ///minimum cut, while the methods \ref minMinCut and \ref
     284    ///maxMinCut return the inclusionwise minimum and maximum cuts of
     285    ///minimum value, resp.  \pre \ref phase1 must be called before.
    282286    void phase2()
    283287    {
Note: See TracChangeset for help on using the changeset viewer.