COIN-OR::LEMON - Graph Library

Changeset 525:9605e051942f in lemon for lemon/preflow.h


Ignore:
Timestamp:
02/23/09 12:10:26 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Various doc improvements

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/preflow.h

    r463 r525  
    3232  ///
    3333  /// Default traits class of Preflow class.
    34   /// \tparam _Digraph Digraph type.
    35   /// \tparam _CapacityMap Capacity map type.
    36   template <typename _Digraph, typename _CapacityMap>
     34  /// \tparam GR Digraph type.
     35  /// \tparam CM Capacity map type.
     36  template <typename GR, typename CM>
    3737  struct PreflowDefaultTraits {
    3838
    3939    /// \brief The type of the digraph the algorithm runs on.
    40     typedef _Digraph Digraph;
     40    typedef GR Digraph;
    4141
    4242    /// \brief The type of the map that stores the arc capacities.
     
    4444    /// The type of the map that stores the arc capacities.
    4545    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
    46     typedef _CapacityMap CapacityMap;
     46    typedef CM CapacityMap;
    4747
    4848    /// \brief The type of the flow values.
     
    105105  /// second phase constructs a feasible maximum flow on each arc.
    106106  ///
    107   /// \tparam _Digraph The type of the digraph the algorithm runs on.
    108   /// \tparam _CapacityMap The type of the capacity map. The default map
    109   /// type is \ref concepts::Digraph::ArcMap "_Digraph::ArcMap<int>".
     107  /// \tparam GR The type of the digraph the algorithm runs on.
     108  /// \tparam CM The type of the capacity map. The default map
     109  /// type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
    110110#ifdef DOXYGEN
    111   template <typename _Digraph, typename _CapacityMap, typename _Traits>
     111  template <typename GR, typename CM, typename TR>
    112112#else
    113   template <typename _Digraph,
    114             typename _CapacityMap = typename _Digraph::template ArcMap<int>,
    115             typename _Traits = PreflowDefaultTraits<_Digraph, _CapacityMap> >
     113  template <typename GR,
     114            typename CM = typename GR::template ArcMap<int>,
     115            typename TR = PreflowDefaultTraits<GR, CM> >
    116116#endif
    117117  class Preflow {
     
    119119
    120120    ///The \ref PreflowDefaultTraits "traits class" of the algorithm.
    121     typedef _Traits Traits;
     121    typedef TR Traits;
    122122    ///The type of the digraph the algorithm runs on.
    123123    typedef typename Traits::Digraph Digraph;
Note: See TracChangeset for help on using the changeset viewer.