Changeset 920:2d6c8075d9d0 in lemon-0.x for src

Timestamp:

09/29/04 16:12:26 (20 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:

• src/hugo/preflow.h (modified) (4 diffs)

src/hugo/preflow.h

@@ -46 +46 @@
   ///
   ///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
@@ -172 +172 @@
     ///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 +194 @@
     ///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 +278 @@
 
     ///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()
     {