[Lemon-commits] [lemon_svn] marci: r1201 - hugo/trunk/src/hugo

[Lemon SVN]

Author: marci
Date: Tue Sep 21 23:10:26 2004
New Revision: 1201

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

Log:
Dox readable more even.


Modified: hugo/trunk/src/hugo/mincostflows.h
==============================================================================
--- hugo/trunk/src/hugo/mincostflows.h	(original)
+++ hugo/trunk/src/hugo/mincostflows.h	Tue Sep 21 23:10:26 2004
@@ -23,15 +23,18 @@
   ///
   /// The class \ref hugo::MinCostFlows "MinCostFlows" implements
   /// an algorithm for finding a flow of value \c k 
-  /// having minimal total cost  
+  /// having minimal total cost 
   /// from a given source node to a given target node in an
-  /// edge-weighted directed graph having nonnegative integer capacities.
-  /// The range of the length (weight or cost) function can be nonnegative reals but 
-  /// the range of the capacity function has to be the set of nonnegative integers.
-  /// This algorithm is intended to use only for for small values of \c k, since  /// it is not a polinomial time algorithm for finding the minimum cost
-  /// maximal flow (in order to find the minimum cost flow of value \c k it 
+  /// edge-weighted directed graph. To this end, 
+  /// the edge-capacities and edge-weitghs 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 use 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). 
+  /// \c i between 0 and \c k. 
   ///
   ///\param Graph The directed graph type the algorithm runs on.
   ///\param LengthMap The type of the length map.
@@ -41,8 +44,6 @@
   template <typename Graph, typename LengthMap, typename CapacityMap>
   class MinCostFlows {
 
-
-
     typedef typename LengthMap::ValueType Length;
 
     //Warning: this should be integer type