[Lemon-commits] [lemon_svn] jacint: r1231 - hugo/trunk/src/hugo

[Lemon SVN]

Author: jacint
Date: Wed Sep 29 16:12:26 2004
New Revision: 1231

Modified:
   hugo/trunk/src/hugo/preflow.h

Log:
some changes in the doc to make things clearer

Modified: hugo/trunk/src/hugo/preflow.h
==============================================================================
--- hugo/trunk/src/hugo/preflow.h	(original)
+++ hugo/trunk/src/hugo/preflow.h	Wed Sep 29 16:12:26 2004
@@ -45,7 +45,7 @@
   ///setFlow.
   ///
   ///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 <tt>bool</tt> node map by
   ///calling \ref minCut(). (\ref minMinCut() and \ref maxMinCut() writes
@@ -171,18 +171,19 @@
       
     ///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)
     {
       flow_prop=fp;
@@ -192,11 +193,12 @@
     
     ///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().
     void phase1()
@@ -275,10 +277,12 @@
     ///Runs the second phase of the preflow algorithm.
 
     ///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()
     {