COIN-OR::LEMON - Graph Library

Changeset 559:c5fd2d996909 in lemon-1.2 for lemon/hao_orlin.h


Ignore:
Timestamp:
03/29/09 23:08:20 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Various doc improvements (#248)

  • Rename all the ugly template parameters (too long and/or starting with an underscore).
  • Rename function parameters starting with an underscore.
  • Extend the doc for many classes.
  • Use LaTeX-style O(...) expressions only for the complicated ones.
  • A lot of small unification changes.
  • Small fixes.
  • Some other improvements.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/hao_orlin.h

    r440 r559  
    5858  /// algorithm or you can use the algorithm of Nagamochi and Ibaraki
    5959  /// which solves the undirected problem in
    60   /// \f$ O(nm + n^2 \log(n)) \f$ time: it is implemented in the
     60  /// \f$ O(nm + n^2 \log n) \f$ time: it is implemented in the
    6161  /// NagamochiIbaraki algorithm class.
    6262  ///
    63   /// \param _Digraph is the graph type of the algorithm.
    64   /// \param _CapacityMap is an edge map of capacities which should
    65   /// be any numreric type. The default type is _Digraph::ArcMap<int>.
    66   /// \param _Tolerance is the handler of the inexact computation. The
    67   /// default type for this is Tolerance<CapacityMap::Value>.
     63  /// \param GR The digraph class the algorithm runs on.
     64  /// \param CAP An arc map of capacities which can be any numreric type.
     65  /// The default type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
     66  /// \param TOL Tolerance class for handling inexact computations. The
     67  /// default tolerance type is \ref Tolerance "Tolerance<CAP::Value>".
    6868#ifdef DOXYGEN
    69   template <typename _Digraph, typename _CapacityMap, typename _Tolerance>
     69  template <typename GR, typename CAP, typename TOL>
    7070#else
    71   template <typename _Digraph,
    72             typename _CapacityMap = typename _Digraph::template ArcMap<int>,
    73             typename _Tolerance = Tolerance<typename _CapacityMap::Value> >
     71  template <typename GR,
     72            typename CAP = typename GR::template ArcMap<int>,
     73            typename TOL = Tolerance<typename CAP::Value> >
    7474#endif
    7575  class HaoOrlin {
    7676  private:
    7777
    78     typedef _Digraph Digraph;
    79     typedef _CapacityMap CapacityMap;
    80     typedef _Tolerance Tolerance;
     78    typedef GR Digraph;
     79    typedef CAP CapacityMap;
     80    typedef TOL Tolerance;
    8181
    8282    typedef typename CapacityMap::Value Value;
     
    818818    /// \name Execution control
    819819    /// The simplest way to execute the algorithm is to use
    820     /// one of the member functions called \c run(...).
     820    /// one of the member functions called \ref run().
    821821    /// \n
    822822    /// If you need more control on the execution,
Note: See TracChangeset for help on using the changeset viewer.