COIN-OR::LEMON - Graph Library

Changeset 2576:ae092c63d3ba in lemon-0.x for lemon/min_cost_flow.h


Ignore:
Timestamp:
02/18/08 04:32:56 (12 years ago)
Author:
Peter Kovacs
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3458
Message:

Improvements in MinCostFlow? and MinCostMaxFlow?.

Main changes:

  • MinCostMaxFlow? also provides dual solution.
  • Change the name of private members to start with "_".
  • Change the name of function parameters not to start with "_".
  • Remove unnecessary documentation for private members.
  • Doc improvements.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/min_cost_flow.h

    r2556 r2576  
    3737  /// a minimum cost flow.
    3838  ///
    39   /// \note \ref MinCostFlow is just an alias for \ref NetworkSimplex,
    40   /// which is the most efficient implementation for the minimum cost
    41   /// flow problem in the LEMON library according to our benchmark
    42   /// tests.
    43   ///
    44   /// \note There are three implementations for the minimum cost flow
    45   /// problem, that can be used exactly the same way.
    46   /// - \ref CapacityScaling
    47   /// - \ref CycleCanceling
    48   /// - \ref NetworkSimplex
    49   ///
    50   /// \note For the detailed documentation of this class see
     39  /// This class is just an alias for \ref NetworkSimplex,
     40  /// which is the most efficient algorithm for the minimum cost
     41  /// flow problem in LEMON according to our benchmark tests.
     42  /// For the detailed documentation of this class see
    5143  /// \ref NetworkSimplex.
    5244  ///
    53   /// \param Graph The directed graph type the algorithm runs on.
    54   /// \param LowerMap The type of the lower bound map.
    55   /// \param CapacityMap The type of the capacity (upper bound) map.
    56   /// \param CostMap The type of the cost (length) map.
    57   /// \param SupplyMap The type of the supply map.
     45  /// There are four implementations for the minimum cost flow problem,
     46  /// which can be used exactly the same way except for the fact that
     47  /// \ref CycleCanceling does not provide dual solution (node
     48  /// potentials) since it is a pure primal method.
     49  /// - \ref CapacityScaling The capacity scaling algorithm.
     50  /// - \ref CostScaling The cost scaling algorithm.
     51  /// - \ref CycleCanceling A cycle-canceling algorithm.
     52  /// - \ref NetworkSimplex The network simplex algorithm.
     53  ///
     54  /// \tparam Graph The directed graph type the algorithm runs on.
     55  /// \tparam LowerMap The type of the lower bound map.
     56  /// \tparam CapacityMap The type of the capacity (upper bound) map.
     57  /// \tparam CostMap The type of the cost (length) map.
     58  /// \tparam SupplyMap The type of the supply map.
    5859  ///
    5960  /// \warning
    60   /// - Edge capacities and costs should be non-negative integers.
    61   ///   However \c CostMap::Value should be signed type.
    62   /// - Supply values should be signed integers.
    63   /// - \c LowerMap::Value must be convertible to
    64   ///   \c CapacityMap::Value and \c CapacityMap::Value must be
    65   ///   convertible to \c SupplyMap::Value.
     61  /// - Edge capacities and costs should be \e non-negative \e integers.
     62  /// - Supply values should be \e signed \e integers.
     63  /// - \c LowerMap::Value must be convertible to \c CapacityMap::Value.
     64  /// - \c CapacityMap::Value and \c SupplyMap::Value must be
     65  ///   convertible to each other.
     66  /// - All value types must be convertible to \c CostMap::Value, which
     67  ///   must be signed type.
    6668  ///
    6769  /// \author Peter Kovacs
Note: See TracChangeset for help on using the changeset viewer.