Changeset 812:4b1b378823dc in lemon-main for lemon/capacity_scaling.h

Timestamp:

11/12/09 23:49:05 (14 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Rebase:

30323866356537663935353430623930626534653939636630353730643832346265623131623731

Message:

Small doc improvements + unifications in MCF classes (#180)

File:

• lemon/capacity_scaling.h (modified) (7 diffs)

lemon/capacity_scaling.h

@@ -36 +36 @@
   /// Default traits class of CapacityScaling algorithm.
   /// \tparam GR Digraph type.
-  /// \tparam V The value type used for flow amounts, capacity bounds
+  /// \tparam V The number type used for flow amounts, capacity bounds
   /// and supply values. By default it is \c int.
-  /// \tparam C The value type used for costs and potentials.
+  /// \tparam C The number type used for costs and potentials.
   /// By default it is the same as \c V.
   template <typename GR, typename V = int, typename C = V>
@@ -76 +76 @@
   ///
   /// \tparam GR The digraph type the algorithm runs on.
-  /// \tparam V The value type used for flow amounts, capacity bounds
+  /// \tparam V The number type used for flow amounts, capacity bounds
   /// and supply values in the algorithm. By default it is \c int.
-  /// \tparam C The value type used for costs and potentials in the
+  /// \tparam C The number type used for costs and potentials in the
   /// algorithm. By default it is the same as \c V.
   ///
-  /// \warning Both value types must be signed and all input data must
+  /// \warning Both number types must be signed and all input data must
   /// be integer.
   /// \warning This algorithm does not support negative costs for such
@@ -123 +123 @@
       /// The digraph contains an arc of negative cost and infinite
       /// upper bound. It means that the objective function is unbounded
-      /// on that arc, however note that it could actually be bounded
+      /// on that arc, however, note that it could actually be bounded
       /// over the feasible flows, but this algroithm cannot handle
       /// these cases.
@@ -308 +308 @@
           std::numeric_limits<Value>::max())
     {
-      // Check the value types
+      // Check the number types
       LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
         "The flow type of CapacityScaling must be signed");
@@ -412 +412 @@
     /// If it is not used before calling \ref run(), the upper bounds
     /// will be set to \ref INF on all arcs (i.e. the flow value will be
-    /// unbounded from above on each arc).
+    /// unbounded from above).
     ///
     /// \param map An arc map storing the upper bounds.
@@ -515 +515 @@
     /// \ref reset() is called, thus only the modified parameters
     /// have to be set again. See \ref reset() for examples.
-    /// However the underlying digraph must not be modified after this
+    /// However, the underlying digraph must not be modified after this
     /// class have been constructed, since it copies and extends the graph.
     ///
@@ -528 +528 @@
     /// \n \c UNBOUNDED if the digraph contains an arc of negative cost
     /// and infinite upper bound. It means that the objective function
-    /// is unbounded on that arc, however note that it could actually be
+    /// is unbounded on that arc, however, note that it could actually be
     /// bounded over the feasible flows, but this algroithm cannot handle
     /// these cases.