[Lemon-commits] [lemon_svn] zsuzska: r1717 - hugo/trunk/src/lemon

[Lemon SVN]

Author: zsuzska
Date: Fri Apr  1 10:16:35 2005
New Revision: 1717

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

Log:
corrections in docs

Modified: hugo/trunk/src/lemon/preflow.h
==============================================================================
--- hugo/trunk/src/lemon/preflow.h	(original)
+++ hugo/trunk/src/lemon/preflow.h	Fri Apr  1 10:16:35 2005
@@ -42,8 +42,8 @@
   ///capacity of the edges and the \e starting \e flow value of the
   ///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()"
   ///or \ref lemon::Preflow::run() "run()", the maximal flow
@@ -134,14 +134,14 @@
     ///The constructor of the class.
 
     ///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.
     ///\param _cap The capacity of the edges. 
     ///\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) :
 	_g(&_gr), _source(_s), _target(_t), _capacity(&_cap),
@@ -178,7 +178,7 @@
 
     ///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
     ///minCut returns a minimum cut.     
@@ -200,7 +200,7 @@
 
     ///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
     ///minCut returns a minimum cut.
@@ -514,9 +514,9 @@
       _capacity=&_cap; 
       status=AFTER_NOTHING; 
     }
-    /// Returns a reference to to capacity map.
+    /// Returns a reference to capacity map.
 
-    /// Returns a reference to to capacity map.
+    /// Returns a reference to capacity map.
     /// 
     const CapacityMap &capacityMap() const { 
       return *_capacity;
@@ -532,9 +532,9 @@
       status=AFTER_NOTHING; 
     }
      
-    /// Returns a reference to to flow map.
+    /// Returns a reference to flow map.
 
-    /// Returns a reference to to flow map.
+    /// Returns a reference to flow map.
     /// 
     const FlowMap &flowMap() const { 
       return *_flow;