COIN-OR::LEMON - Graph Library

Changeset 525:9605e051942f in lemon for lemon/circulation.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/circulation.h

    r463 r525  
    3232  ///
    3333  /// Default traits class of Circulation class.
    34   /// \tparam _Diraph Digraph type.
    35   /// \tparam _LCapMap Lower bound capacity map type.
    36   /// \tparam _UCapMap Upper bound capacity map type.
    37   /// \tparam _DeltaMap Delta map type.
    38   template <typename _Diraph, typename _LCapMap,
    39             typename _UCapMap, typename _DeltaMap>
     34  /// \tparam GR Digraph type.
     35  /// \tparam LM Lower bound capacity map type.
     36  /// \tparam UM Upper bound capacity map type.
     37  /// \tparam DM Delta map type.
     38  template <typename GR, typename LM,
     39            typename UM, typename DM>
    4040  struct CirculationDefaultTraits {
    4141
    4242    /// \brief The type of the digraph the algorithm runs on.
    43     typedef _Diraph Digraph;
     43    typedef GR Digraph;
    4444
    4545    /// \brief The type of the map that stores the circulation lower
     
    4848    /// The type of the map that stores the circulation lower bound.
    4949    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
    50     typedef _LCapMap LCapMap;
     50    typedef LM LCapMap;
    5151
    5252    /// \brief The type of the map that stores the circulation upper
     
    5555    /// The type of the map that stores the circulation upper bound.
    5656    /// It must meet the \ref concepts::ReadMap "ReadMap" concept.
    57     typedef _UCapMap UCapMap;
     57    typedef UM UCapMap;
    5858
    5959    /// \brief The type of the map that stores the lower bound for
     
    6363    /// of the nodes. It must meet the \ref concepts::ReadMap "ReadMap"
    6464    /// concept.
    65     typedef _DeltaMap DeltaMap;
     65    typedef DM DeltaMap;
    6666
    6767    /// \brief The type of the flow values.
     
    138138     in this way.
    139139
    140      \tparam _Digraph The type of the digraph the algorithm runs on.
    141      \tparam _LCapMap The type of the lower bound capacity map. The default
    142      map type is \ref concepts::Digraph::ArcMap "_Digraph::ArcMap<int>".
    143      \tparam _UCapMap The type of the upper bound capacity map. The default
    144      map type is \c _LCapMap.
    145      \tparam _DeltaMap The type of the map that stores the lower bound
     140     \tparam GR The type of the digraph the algorithm runs on.
     141     \tparam LM The type of the lower bound capacity map. The default
     142     map type is \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
     143     \tparam UM The type of the upper bound capacity map. The default
     144     map type is \c LM.
     145     \tparam DM The type of the map that stores the lower bound
    146146     for the supply of the nodes. The default map type is
    147      \c _Digraph::ArcMap<_UCapMap::Value>.
     147     \ref concepts::Digraph::NodeMap "GR::NodeMap<UM::Value>".
    148148  */
    149149#ifdef DOXYGEN
    150 template< typename _Digraph,
    151           typename _LCapMap,
    152           typename _UCapMap,
    153           typename _DeltaMap,
    154           typename _Traits >
     150template< typename GR,
     151          typename LM,
     152          typename UM,
     153          typename DM,
     154          typename TR >
    155155#else
    156 template< typename _Digraph,
    157           typename _LCapMap = typename _Digraph::template ArcMap<int>,
    158           typename _UCapMap = _LCapMap,
    159           typename _DeltaMap = typename _Digraph::
    160                                template NodeMap<typename _UCapMap::Value>,
    161           typename _Traits=CirculationDefaultTraits<_Digraph, _LCapMap,
    162                                                     _UCapMap, _DeltaMap> >
     156template< typename GR,
     157          typename LM = typename GR::template ArcMap<int>,
     158          typename UM = LM,
     159          typename DM = typename GR::template NodeMap<typename UM::Value>,
     160          typename TR = CirculationDefaultTraits<GR, LM, UM, DM> >
    163161#endif
    164162  class Circulation {
     
    166164
    167165    ///The \ref CirculationDefaultTraits "traits class" of the algorithm.
    168     typedef _Traits Traits;
     166    typedef TR Traits;
    169167    ///The type of the digraph the algorithm runs on.
    170168    typedef typename Traits::Digraph Digraph;
Note: See TracChangeset for help on using the changeset viewer.