Index: src/hugo/preflow.h
===================================================================
--- src/hugo/preflow.h (revision 911)
+++ src/hugo/preflow.h (revision 920)
@@ -46,5 +46,5 @@
///
///After running \ref hugo::Preflow::phase1() "phase1()"
- ///or \ref hugo::Preflow::run() "run()", the actual flow
+ ///or \ref hugo::Preflow::run() "run()", the maximal flow
///value can be obtained by calling \ref flowValue(). The minimum
///value cut can be written into a `bool` node map by
@@ -172,16 +172,17 @@
///Runs the first phase of the preflow algorithm.
- ///The preflow algorithm consists of two phases, this method runs the
- ///first phase. After the first phase the maximum flow value and a
- ///minimum value cut can already be computed, though a maximum flow
- ///is not yet obtained. So after calling this method \ref flowValue
- ///and \ref minCut gives proper results.
- ///\warning \ref minMinCut and \ref maxMinCut do not
- ///give minimum value cuts unless calling \ref phase2.
- ///\pre The starting flow must be
- /// - a constant zero flow if \c fp is \c ZERO_FLOW,
- /// - an arbitary flow if \c fp is \c GEN_FLOW,
- /// - an arbitary preflow if \c fp is \c PRE_FLOW,
- /// - any map if \c fp is NO_FLOW.
+ ///The preflow algorithm consists of two phases, this method runs
+ ///the first phase. After the first phase the maximum flow value
+ ///and a minimum value cut can already be computed, though a
+ ///maximum flow is not yet obtained. So after calling this method
+ ///\ref flowValue returns the value of a maximum flow and \ref
+ ///minCut returns a minimum cut.
+ ///\warning \ref minMinCut and \ref maxMinCut do not give minimum
+ ///value cuts unless calling \ref phase2.
+ ///\pre The starting flow must be
+ ///- a constant zero flow if \c fp is \c ZERO_FLOW,
+ ///- an arbitary flow if \c fp is \c GEN_FLOW,
+ ///- an arbitary preflow if \c fp is \c PRE_FLOW,
+ ///- any map if \c fp is NO_FLOW.
void phase1(FlowEnum fp)
{
@@ -193,9 +194,10 @@
///Runs the first phase of the preflow algorithm.
- ///The preflow algorithm consists of two phases, this method runs the
- ///first phase. After the first phase the maximum flow value and a
- ///minimum value cut can already be computed, though a maximum flow
- ///is not yet obtained. So after calling this method \ref flowValue
- ///and \ref MinCut() gives proper results.
+ ///The preflow algorithm consists of two phases, this method runs
+ ///the first phase. After the first phase the maximum flow value
+ ///and a minimum value cut can already be computed, though a
+ ///maximum flow is not yet obtained. So after calling this method
+ ///\ref flowValue returns the value of a maximum flow and \ref
+ ///minCut returns a minimum cut.
///\warning \ref minCut(), \ref minMinCut() and \ref maxMinCut() do not
///give minimum value cuts unless calling \ref phase2().
@@ -276,8 +278,10 @@
///The preflow algorithm consists of two phases, this method runs
- ///the second phase. After calling \ref phase1 and then
- ///\ref phase2 the methods \ref flowValue, \ref minCut,
- ///\ref minMinCut and \ref maxMinCut give proper results.
- ///\pre \ref phase1 must be called before.
+ ///the second phase. After calling \ref phase1 and then \ref
+ ///phase2, \ref flow contains a maximum flow, \ref flowValue
+ ///returns the value of a maximum flow, \ref minCut returns a
+ ///minimum cut, while the methods \ref minMinCut and \ref
+ ///maxMinCut return the inclusionwise minimum and maximum cuts of
+ ///minimum value, resp. \pre \ref phase1 must be called before.
void phase2()
{