COIN-OR::LEMON - Graph Library

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

    r811 r812  
    3636  /// Default traits class of CapacityScaling algorithm.
    3737  /// \tparam GR Digraph type.
    38   /// \tparam V The value type used for flow amounts, capacity bounds
     38  /// \tparam V The number type used for flow amounts, capacity bounds
    3939  /// and supply values. By default it is \c int.
    40   /// \tparam C The value type used for costs and potentials.
     40  /// \tparam C The number type used for costs and potentials.
    4141  /// By default it is the same as \c V.
    4242  template <typename GR, typename V = int, typename C = V>
     
    7676  ///
    7777  /// \tparam GR The digraph type the algorithm runs on.
    78   /// \tparam V The value type used for flow amounts, capacity bounds
     78  /// \tparam V The number type used for flow amounts, capacity bounds
    7979  /// and supply values in the algorithm. By default it is \c int.
    80   /// \tparam C The value type used for costs and potentials in the
     80  /// \tparam C The number type used for costs and potentials in the
    8181  /// algorithm. By default it is the same as \c V.
    8282  ///
    83   /// \warning Both value types must be signed and all input data must
     83  /// \warning Both number types must be signed and all input data must
    8484  /// be integer.
    8585  /// \warning This algorithm does not support negative costs for such
     
    123123      /// The digraph contains an arc of negative cost and infinite
    124124      /// upper bound. It means that the objective function is unbounded
    125       /// on that arc, however note that it could actually be bounded
     125      /// on that arc, however, note that it could actually be bounded
    126126      /// over the feasible flows, but this algroithm cannot handle
    127127      /// these cases.
     
    308308          std::numeric_limits<Value>::max())
    309309    {
    310       // Check the value types
     310      // Check the number types
    311311      LEMON_ASSERT(std::numeric_limits<Value>::is_signed,
    312312        "The flow type of CapacityScaling must be signed");
     
    412412    /// If it is not used before calling \ref run(), the upper bounds
    413413    /// will be set to \ref INF on all arcs (i.e. the flow value will be
    414     /// unbounded from above on each arc).
     414    /// unbounded from above).
    415415    ///
    416416    /// \param map An arc map storing the upper bounds.
     
    515515    /// \ref reset() is called, thus only the modified parameters
    516516    /// have to be set again. See \ref reset() for examples.
    517     /// However the underlying digraph must not be modified after this
     517    /// However, the underlying digraph must not be modified after this
    518518    /// class have been constructed, since it copies and extends the graph.
    519519    ///
     
    528528    /// \n \c UNBOUNDED if the digraph contains an arc of negative cost
    529529    /// and infinite upper bound. It means that the objective function
    530     /// is unbounded on that arc, however note that it could actually be
     530    /// is unbounded on that arc, however, note that it could actually be
    531531    /// bounded over the feasible flows, but this algroithm cannot handle
    532532    /// these cases.
Note: See TracChangeset for help on using the changeset viewer.