Changeset 1527:7ceab500e1f6 in lemon-0.x for lemon/min_cost_flow.h

Timestamp:

07/01/05 12:33:27 (19 years ago)

Author:

athos

Branch:

default

Phase:

public

Convert:

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

Message:

Doc review+corrections in my own documentation according to the reviewers comments.

File:

• lemon/min_cost_flow.h (modified) (3 diffs)

lemon/min_cost_flow.h

@@ -39 +39 @@
   /// The class \ref lemon::MinCostFlow "MinCostFlow" implements an
   /// algorithm for finding a flow of value \c k having minimal total
-  /// cost from a given source node to a given target node in an
-  /// edge-weighted directed graph. To this end, the edge-capacities
-  /// and edge-weights have to be nonnegative.  The edge-capacities
-  /// should be integers, but the edge-weights can be integers, reals
-  /// or of other comparable numeric type.  This algorithm is intended
-  /// to be used only for small values of \c k, since it is only
-  /// polynomial in k, not in the length of k (which is log k):  in
-  /// order to find the minimum cost flow of value \c k it finds the
-  /// minimum cost flow of value \c i for every \c i between 0 and \c
-  /// k.
+  /// cost from a given source node to a given target node in a
+  /// directed graph with a cost function on the edges. To
+  /// this end, the edge-capacities and edge-costs have to be
+  /// nonnegative.  The edge-capacities should be integers, but the
+  /// edge-costs can be integers, reals or of other comparable
+  /// numeric type.  This algorithm is intended to be used only for
+  /// small values of \c k, since it is only polynomial in k, not in
+  /// the length of k (which is log k): in order to find the minimum
+  /// cost flow of value \c k it finds the minimum cost flow of value
+  /// \c i for every \c i between 0 and \c k.
   ///
   ///\param Graph The directed graph type the algorithm runs on.
@@ -118 +118 @@
     
     \param _g The directed graph the algorithm runs on. 
-    \param _length The length (weight or cost) of the edges. 
+    \param _length The length (cost) of the edges. 
     \param _cap The capacity of the edges. 
     \param _s Source node.
@@ -204 +204 @@
     }
 
-    /// Total weight of the found flow.
-
-    /// This function gives back the total weight of the found flow.
+    /// Total cost of the found flow.
+
+    /// This function gives back the total cost of the found flow.
     Length totalLength(){
       return total_length;