COIN-OR::LEMON - Graph Library

Changeset 812:4b1b378823dc in lemon-1.2 for lemon/cost_scaling.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/cost_scaling.h

    r810 r812  
    4141  /// Default traits class of CostScaling algorithm.
    4242  /// \tparam GR Digraph type.
    43   /// \tparam V The value type used for flow amounts, capacity bounds
     43  /// \tparam V The number type used for flow amounts, capacity bounds
    4444  /// and supply values. By default it is \c int.
    45   /// \tparam C The value type used for costs and potentials.
     45  /// \tparam C The number type used for costs and potentials.
    4646  /// By default it is the same as \c V.
    4747#ifdef DOXYGEN
     
    102102  ///
    103103  /// \tparam GR The digraph type the algorithm runs on.
    104   /// \tparam V The value type used for flow amounts, capacity bounds
     104  /// \tparam V The number type used for flow amounts, capacity bounds
    105105  /// and supply values in the algorithm. By default it is \c int.
    106   /// \tparam C The value type used for costs and potentials in the
     106  /// \tparam C The number type used for costs and potentials in the
    107107  /// algorithm. By default it is the same as \c V.
    108108  ///
    109   /// \warning Both value types must be signed and all input data must
     109  /// \warning Both number types must be signed and all input data must
    110110  /// be integer.
    111111  /// \warning This algorithm does not support negative costs for such
     
    158158      /// The digraph contains an arc of negative cost and infinite
    159159      /// upper bound. It means that the objective function is unbounded
    160       /// on that arc, however note that it could actually be bounded
     160      /// on that arc, however, note that it could actually be bounded
    161161      /// over the feasible flows, but this algroithm cannot handle
    162162      /// these cases.
     
    326326          std::numeric_limits<Value>::max())
    327327    {
    328       // Check the value types
     328      // Check the number types
    329329      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
    330330        "The flow type of CostScaling must be signed");
     
    434434    /// If it is not used before calling \ref run(), the upper bounds
    435435    /// will be set to \ref INF on all arcs (i.e. the flow value will be
    436     /// unbounded from above on each arc).
     436    /// unbounded from above).
    437437    ///
    438438    /// \param map An arc map storing the upper bounds.
     
    550550    /// \n \c UNBOUNDED if the digraph contains an arc of negative cost
    551551    /// and infinite upper bound. It means that the objective function
    552     /// is unbounded on that arc, however note that it could actually be
     552    /// is unbounded on that arc, however, note that it could actually be
    553553    /// bounded over the feasible flows, but this algroithm cannot handle
    554554    /// these cases.
     
    572572    /// used, all the parameters given before are kept for the next
    573573    /// \ref run() call.
    574     /// However the underlying digraph must not be modified after this
     574    /// However, the underlying digraph must not be modified after this
    575575    /// class have been constructed, since it copies and extends the graph.
    576576    ///
Note: See TracChangeset for help on using the changeset viewer.