Changeset 1285:bf1840562c67 in lemon-0.x

Timestamp:

04/01/05 10:16:35 (19 years ago)

Author:

zsuzska

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1717

Message:

corrections in docs

File:

• src/lemon/preflow.h (modified) (7 diffs)

src/lemon/preflow.h

@@ -43 +43 @@
   ///edges should be passed to the algorithm through the
   ///constructor. It is possible to change these quantities using the
-  ///functions \ref source, \ref target, \ref setCap and \ref
-  ///setFlow.
+  ///functions \ref source, \ref target, \ref capacityMap and \ref
+  ///flowMap.
   ///
   ///After running \ref lemon::Preflow::phase1() "phase1()"
@@ -135 +135 @@
 
     ///The constructor of the class. 
-    ///\param _G The directed graph the algorithm runs on. 
+    ///\param _gr The directed graph the algorithm runs on. 
     ///\param _s The source node.
     ///\param _t The target node.
@@ -141 +141 @@
     ///\param _f The flow of the edges. 
     ///Except the graph, all of these parameters can be reset by
-    ///calling \ref source, \ref target, \ref setCap and \ref
-    ///setFlow, resp.
+    ///calling \ref source, \ref target, \ref capacityMap and \ref
+    ///flowMap, resp.
       Preflow(const Graph& _gr, Node _s, Node _t, 
               const CapacityMap& _cap, FlowMap& _f) :
@@ -179 +179 @@
     ///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
+    ///and a minimum value cut can already be computed, although a
     ///maximum flow is not yet obtained. So after calling this method
     ///\ref flowValue returns the value of a maximum flow and \ref
@@ -201 +201 @@
     ///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
+    ///and a minimum value cut can already be computed, although a
     ///maximum flow is not yet obtained. So after calling this method
     ///\ref flowValue returns the value of a maximum flow and \ref
@@ -515 +515 @@
       status=AFTER_NOTHING; 
     }
-    /// Returns a reference to to capacity map.
-
-    /// Returns a reference to to capacity map.
+    /// Returns a reference to capacity map.
+
+    /// Returns a reference to capacity map.
     /// 
     const CapacityMap &capacityMap() const { 
@@ -533 +533 @@
     }
      
-    /// Returns a reference to to flow map.
-
-    /// Returns a reference to to flow map.
+    /// Returns a reference to flow map.
+
+    /// Returns a reference to flow map.
     /// 
     const FlowMap &flowMap() const {