COIN-OR::LEMON - Graph Library

Changeset 606:c5fd2d996909 in lemon for lemon/circulation.h


Ignore:
Timestamp:
03/29/09 23:08:20 (10 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/circulation.h

    r525 r606  
    216216    ///@{
    217217
    218     template <typename _FlowMap>
     218    template <typename T>
    219219    struct SetFlowMapTraits : public Traits {
    220       typedef _FlowMap FlowMap;
     220      typedef T FlowMap;
    221221      static FlowMap *createFlowMap(const Digraph&) {
    222222        LEMON_ASSERT(false, "FlowMap is not initialized");
     
    230230    /// \ref named-templ-param "Named parameter" for setting FlowMap
    231231    /// type.
    232     template <typename _FlowMap>
     232    template <typename T>
    233233    struct SetFlowMap
    234234      : public Circulation<Digraph, LCapMap, UCapMap, DeltaMap,
    235                            SetFlowMapTraits<_FlowMap> > {
     235                           SetFlowMapTraits<T> > {
    236236      typedef Circulation<Digraph, LCapMap, UCapMap, DeltaMap,
    237                           SetFlowMapTraits<_FlowMap> > Create;
     237                          SetFlowMapTraits<T> > Create;
    238238    };
    239239
    240     template <typename _Elevator>
     240    template <typename T>
    241241    struct SetElevatorTraits : public Traits {
    242       typedef _Elevator Elevator;
     242      typedef T Elevator;
    243243      static Elevator *createElevator(const Digraph&, int) {
    244244        LEMON_ASSERT(false, "Elevator is not initialized");
     
    256256    /// \ref run() or \ref init().
    257257    /// \sa SetStandardElevator
    258     template <typename _Elevator>
     258    template <typename T>
    259259    struct SetElevator
    260260      : public Circulation<Digraph, LCapMap, UCapMap, DeltaMap,
    261                            SetElevatorTraits<_Elevator> > {
     261                           SetElevatorTraits<T> > {
    262262      typedef Circulation<Digraph, LCapMap, UCapMap, DeltaMap,
    263                           SetElevatorTraits<_Elevator> > Create;
     263                          SetElevatorTraits<T> > Create;
    264264    };
    265265
    266     template <typename _Elevator>
     266    template <typename T>
    267267    struct SetStandardElevatorTraits : public Traits {
    268       typedef _Elevator Elevator;
     268      typedef T Elevator;
    269269      static Elevator *createElevator(const Digraph& digraph, int max_level) {
    270270        return new Elevator(digraph, max_level);
     
    284284    /// before calling \ref run() or \ref init().
    285285    /// \sa SetElevator
    286     template <typename _Elevator>
     286    template <typename T>
    287287    struct SetStandardElevator
    288288      : public Circulation<Digraph, LCapMap, UCapMap, DeltaMap,
    289                        SetStandardElevatorTraits<_Elevator> > {
     289                       SetStandardElevatorTraits<T> > {
    290290      typedef Circulation<Digraph, LCapMap, UCapMap, DeltaMap,
    291                       SetStandardElevatorTraits<_Elevator> > Create;
     291                      SetStandardElevatorTraits<T> > Create;
    292292    };
    293293
     
    683683    ///
    684684    /// \note This function calls \ref barrier() for each node,
    685     /// so it runs in \f$O(n)\f$ time.
     685    /// so it runs in O(n) time.
    686686    ///
    687687    /// \pre Either \ref run() or \ref init() must be called before
Note: See TracChangeset for help on using the changeset viewer.