COIN-OR::LEMON - Graph Library

Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/network_simplex.h

    r835 r802  
    5151  /// in LEMON for the minimum cost flow problem.
    5252  /// Moreover it supports both directions of the supply/demand inequality
    53   /// constraints. For more information, see \ref SupplyType.
     53  /// constraints. For more information see \ref SupplyType.
    5454  ///
    5555  /// Most of the parameters of the problem (except for the digraph)
     
    6060  /// \tparam GR The digraph type the algorithm runs on.
    6161  /// \tparam V The value type used for flow amounts, capacity bounds
    62   /// and supply values in the algorithm. By default, it is \c int.
     62  /// and supply values in the algorithm. By default it is \c int.
    6363  /// \tparam C The value type used for costs and potentials in the
    64   /// algorithm. By default, it is the same as \c V.
     64  /// algorithm. By default it is the same as \c V.
    6565  ///
    6666  /// \warning Both value types must be signed and all input data must
     
    6969  /// \note %NetworkSimplex provides five different pivot rule
    7070  /// implementations, from which the most efficient one is used
    71   /// by default. For more information, see \ref PivotRule.
     71  /// by default. For more information see \ref PivotRule.
    7272  template <typename GR, typename V = int, typename C = V>
    7373  class NetworkSimplex
     
    125125    /// implementations that significantly affect the running time
    126126    /// of the algorithm.
    127     /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
     127    /// By default \ref BLOCK_SEARCH "Block Search" is used, which
    128128    /// proved to be the most efficient and the most robust on various
    129129    /// test inputs according to our benchmark tests.
    130     /// However, another pivot rule can be selected using the \ref run()
     130    /// However another pivot rule can be selected using the \ref run()
    131131    /// function with the proper parameter.
    132132    enum PivotRule {
    133133
    134       /// The \e First \e Eligible pivot rule.
     134      /// The First Eligible pivot rule.
    135135      /// The next eligible arc is selected in a wraparound fashion
    136136      /// in every iteration.
    137137      FIRST_ELIGIBLE,
    138138
    139       /// The \e Best \e Eligible pivot rule.
     139      /// The Best Eligible pivot rule.
    140140      /// The best eligible arc is selected in every iteration.
    141141      BEST_ELIGIBLE,
    142142
    143       /// The \e Block \e Search pivot rule.
     143      /// The Block Search pivot rule.
    144144      /// A specified number of arcs are examined in every iteration
    145145      /// in a wraparound fashion and the best eligible arc is selected
     
    147147      BLOCK_SEARCH,
    148148
    149       /// The \e Candidate \e List pivot rule.
     149      /// The Candidate List pivot rule.
    150150      /// In a major iteration a candidate list is built from eligible arcs
    151151      /// in a wraparound fashion and in the following minor iterations
     
    153153      CANDIDATE_LIST,
    154154
    155       /// The \e Altering \e Candidate \e List pivot rule.
     155      /// The Altering Candidate List pivot rule.
    156156      /// It is a modified version of the Candidate List method.
    157157      /// It keeps only the several best eligible arcs from the former
     
    813813    /// type will be used.
    814814    ///
    815     /// For more information, see \ref SupplyType.
     815    /// For more information see \ref SupplyType.
    816816    ///
    817817    /// \return <tt>(*this)</tt>
     
    845845    /// \ref reset() is called, thus only the modified parameters
    846846    /// have to be set again. See \ref reset() for examples.
    847     /// However, the underlying digraph must not be modified after this
     847    /// However the underlying digraph must not be modified after this
    848848    /// class have been constructed, since it copies and extends the graph.
    849849    ///
    850850    /// \param pivot_rule The pivot rule that will be used during the
    851     /// algorithm. For more information, see \ref PivotRule.
     851    /// algorithm. For more information see \ref PivotRule.
    852852    ///
    853853    /// \return \c INFEASIBLE if no feasible flow exists,
     
    874874    /// used, all the parameters given before are kept for the next
    875875    /// \ref run() call.
    876     /// However, the underlying digraph must not be modified after this
     876    /// However the underlying digraph must not be modified after this
    877877    /// class have been constructed, since it copies and extends the graph.
    878878    ///
Note: See TracChangeset for help on using the changeset viewer.