COIN-OR::LEMON - Graph Library

Changeset 878:4b1b378823dc in lemon for lemon/network_simplex.h


Ignore:
Timestamp:
11/12/09 23:49:05 (10 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Rebase:
30323866356537663935353430623930626534653939636630353730643832346265623131623731
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/network_simplex.h

    r877 r878  
    4444  /// \ref amo93networkflows, \ref dantzig63linearprog,
    4545  /// \ref kellyoneill91netsimplex.
    46   /// This algorithm is a specialized version of the linear programming
    47   /// simplex method directly for the minimum cost flow problem.
    48   /// It is one of the most efficient solution methods.
     46  /// This algorithm is a highly efficient specialized version of the
     47  /// linear programming simplex method directly for the minimum cost
     48  /// flow problem.
    4949  ///
    50   /// In general this class is the fastest implementation available
    51   /// in LEMON for the minimum cost flow problem.
    52   /// Moreover it supports both directions of the supply/demand inequality
     50  /// In general, %NetworkSimplex is the fastest implementation available
     51  /// in LEMON for this problem.
     52  /// Moreover, it supports both directions of the supply/demand inequality
    5353  /// constraints. For more information, see \ref SupplyType.
    5454  ///
     
    5959  ///
    6060  /// \tparam GR The digraph type the algorithm runs on.
    61   /// \tparam V The value type used for flow amounts, capacity bounds
     61  /// \tparam V The number type used for flow amounts, capacity bounds
    6262  /// and supply values in the algorithm. By default, it is \c int.
    63   /// \tparam C The value type used for costs and potentials in the
     63  /// \tparam C The number type used for costs and potentials in the
    6464  /// algorithm. By default, it is the same as \c V.
    6565  ///
    66   /// \warning Both value types must be signed and all input data must
     66  /// \warning Both number types must be signed and all input data must
    6767  /// be integer.
    6868  ///
     
    127127    /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
    128128    /// proved to be the most efficient and the most robust on various
    129     /// test inputs according to our benchmark tests.
     129    /// test inputs.
    130130    /// However, another pivot rule can be selected using the \ref run()
    131131    /// function with the proper parameter.
     
    638638          std::numeric_limits<Value>::infinity() : MAX)
    639639    {
    640       // Check the value types
     640      // Check the number types
    641641      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
    642642        "The flow type of NetworkSimplex must be signed");
     
    730730    /// If it is not used before calling \ref run(), the upper bounds
    731731    /// will be set to \ref INF on all arcs (i.e. the flow value will be
    732     /// unbounded from above on each arc).
     732    /// unbounded from above).
    733733    ///
    734734    /// \param map An arc map storing the upper bounds.
Note: See TracChangeset for help on using the changeset viewer.