COIN-OR::LEMON - Graph Library

Changeset 833:e20173729589 in lemon for lemon/network_simplex.h


Ignore:
Timestamp:
11/13/09 18:10:06 (10 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Small doc fixes in several files (#331)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/network_simplex.h

    r777 r833  
    4949  /// in LEMON for the minimum cost flow problem.
    5050  /// Moreover it supports both directions of the supply/demand inequality
    51   /// constraints. For more information see \ref SupplyType.
     51  /// constraints. For more information, see \ref SupplyType.
    5252  ///
    5353  /// Most of the parameters of the problem (except for the digraph)
     
    5858  /// \tparam GR The digraph type the algorithm runs on.
    5959  /// \tparam V The value type used for flow amounts, capacity bounds
    60   /// and supply values in the algorithm. By default it is \c int.
     60  /// and supply values in the algorithm. By default, it is \c int.
    6161  /// \tparam C The value type used for costs and potentials in the
    62   /// algorithm. By default it is the same as \c V.
     62  /// algorithm. By default, it is the same as \c V.
    6363  ///
    6464  /// \warning Both value types must be signed and all input data must
     
    6767  /// \note %NetworkSimplex provides five different pivot rule
    6868  /// implementations, from which the most efficient one is used
    69   /// by default. For more information see \ref PivotRule.
     69  /// by default. For more information, see \ref PivotRule.
    7070  template <typename GR, typename V = int, typename C = V>
    7171  class NetworkSimplex
     
    123123    /// implementations that significantly affect the running time
    124124    /// of the algorithm.
    125     /// By default \ref BLOCK_SEARCH "Block Search" is used, which
     125    /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
    126126    /// proved to be the most efficient and the most robust on various
    127127    /// test inputs according to our benchmark tests.
    128     /// However another pivot rule can be selected using the \ref run()
     128    /// However, another pivot rule can be selected using the \ref run()
    129129    /// function with the proper parameter.
    130130    enum PivotRule {
    131131
    132       /// The First Eligible pivot rule.
     132      /// The \e First \e Eligible pivot rule.
    133133      /// The next eligible arc is selected in a wraparound fashion
    134134      /// in every iteration.
    135135      FIRST_ELIGIBLE,
    136136
    137       /// The Best Eligible pivot rule.
     137      /// The \e Best \e Eligible pivot rule.
    138138      /// The best eligible arc is selected in every iteration.
    139139      BEST_ELIGIBLE,
    140140
    141       /// The Block Search pivot rule.
     141      /// The \e Block \e Search pivot rule.
    142142      /// A specified number of arcs are examined in every iteration
    143143      /// in a wraparound fashion and the best eligible arc is selected
     
    145145      BLOCK_SEARCH,
    146146
    147       /// The Candidate List pivot rule.
     147      /// The \e Candidate \e List pivot rule.
    148148      /// In a major iteration a candidate list is built from eligible arcs
    149149      /// in a wraparound fashion and in the following minor iterations
     
    151151      CANDIDATE_LIST,
    152152
    153       /// The Altering Candidate List pivot rule.
     153      /// The \e Altering \e Candidate \e List pivot rule.
    154154      /// It is a modified version of the Candidate List method.
    155155      /// It keeps only the several best eligible arcs from the former
     
    811811    /// type will be used.
    812812    ///
    813     /// For more information see \ref SupplyType.
     813    /// For more information, see \ref SupplyType.
    814814    ///
    815815    /// \return <tt>(*this)</tt>
     
    843843    /// \ref reset() is called, thus only the modified parameters
    844844    /// have to be set again. See \ref reset() for examples.
    845     /// However the underlying digraph must not be modified after this
     845    /// However, the underlying digraph must not be modified after this
    846846    /// class have been constructed, since it copies and extends the graph.
    847847    ///
    848848    /// \param pivot_rule The pivot rule that will be used during the
    849     /// algorithm. For more information see \ref PivotRule.
     849    /// algorithm. For more information, see \ref PivotRule.
    850850    ///
    851851    /// \return \c INFEASIBLE if no feasible flow exists,
     
    872872    /// used, all the parameters given before are kept for the next
    873873    /// \ref run() call.
    874     /// However the underlying digraph must not be modified after this
     874    /// However, the underlying digraph must not be modified after this
    875875    /// class have been constructed, since it copies and extends the graph.
    876876    ///
Note: See TracChangeset for help on using the changeset viewer.