lemon/network_simplex.h
changeset 878 4b1b378823dc
parent 877 fe80a8145653
child 898 75c97c3786d6
child 910 f3bc4e9b5f3a
     1.1 --- a/lemon/network_simplex.h	Thu Nov 12 23:45:15 2009 +0100
     1.2 +++ b/lemon/network_simplex.h	Thu Nov 12 23:49:05 2009 +0100
     1.3 @@ -43,13 +43,13 @@
     1.4    /// for finding a \ref min_cost_flow "minimum cost flow"
     1.5    /// \ref amo93networkflows, \ref dantzig63linearprog,
     1.6    /// \ref kellyoneill91netsimplex.
     1.7 -  /// This algorithm is a specialized version of the linear programming
     1.8 -  /// simplex method directly for the minimum cost flow problem.
     1.9 -  /// It is one of the most efficient solution methods.
    1.10 +  /// This algorithm is a highly efficient specialized version of the
    1.11 +  /// linear programming simplex method directly for the minimum cost
    1.12 +  /// flow problem.
    1.13    ///
    1.14 -  /// In general this class is the fastest implementation available
    1.15 -  /// in LEMON for the minimum cost flow problem.
    1.16 -  /// Moreover it supports both directions of the supply/demand inequality
    1.17 +  /// In general, %NetworkSimplex is the fastest implementation available
    1.18 +  /// in LEMON for this problem.
    1.19 +  /// Moreover, it supports both directions of the supply/demand inequality
    1.20    /// constraints. For more information, see \ref SupplyType.
    1.21    ///
    1.22    /// Most of the parameters of the problem (except for the digraph)
    1.23 @@ -58,12 +58,12 @@
    1.24    /// specified, then default values will be used.
    1.25    ///
    1.26    /// \tparam GR The digraph type the algorithm runs on.
    1.27 -  /// \tparam V The value type used for flow amounts, capacity bounds
    1.28 +  /// \tparam V The number type used for flow amounts, capacity bounds
    1.29    /// and supply values in the algorithm. By default, it is \c int.
    1.30 -  /// \tparam C The value type used for costs and potentials in the
    1.31 +  /// \tparam C The number type used for costs and potentials in the
    1.32    /// algorithm. By default, it is the same as \c V.
    1.33    ///
    1.34 -  /// \warning Both value types must be signed and all input data must
    1.35 +  /// \warning Both number types must be signed and all input data must
    1.36    /// be integer.
    1.37    ///
    1.38    /// \note %NetworkSimplex provides five different pivot rule
    1.39 @@ -126,7 +126,7 @@
    1.40      /// of the algorithm.
    1.41      /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
    1.42      /// proved to be the most efficient and the most robust on various
    1.43 -    /// test inputs according to our benchmark tests.
    1.44 +    /// test inputs.
    1.45      /// However, another pivot rule can be selected using the \ref run()
    1.46      /// function with the proper parameter.
    1.47      enum PivotRule {
    1.48 @@ -637,7 +637,7 @@
    1.49        INF(std::numeric_limits<Value>::has_infinity ?
    1.50            std::numeric_limits<Value>::infinity() : MAX)
    1.51      {
    1.52 -      // Check the value types
    1.53 +      // Check the number types
    1.54        LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
    1.55          "The flow type of NetworkSimplex must be signed");
    1.56        LEMON_ASSERT(std::numeric_limits<Cost>::is_signed,
    1.57 @@ -729,7 +729,7 @@
    1.58      /// This function sets the upper bounds (capacities) on the arcs.
    1.59      /// If it is not used before calling \ref run(), the upper bounds
    1.60      /// will be set to \ref INF on all arcs (i.e. the flow value will be
    1.61 -    /// unbounded from above on each arc).
    1.62 +    /// unbounded from above).
    1.63      ///
    1.64      /// \param map An arc map storing the upper bounds.
    1.65      /// Its \c Value type must be convertible to the \c Value type