lemon/circulation.h
changeset 719 ba79e8d64448
parent 713 4ac30454f1c1
parent 689 86c49553fea5
child 786 e20173729589
     1.1 --- a/lemon/circulation.h	Thu Aug 20 20:34:30 2009 +0200
     1.2 +++ b/lemon/circulation.h	Fri Sep 25 09:33:09 2009 +0200
     1.3 @@ -72,7 +72,11 @@
     1.4      /// The type of the map that stores the flow values.
     1.5      /// It must conform to the \ref concepts::ReadWriteMap "ReadWriteMap"
     1.6      /// concept.
     1.7 +#ifdef DOXYGEN
     1.8 +    typedef GR::ArcMap<Value> FlowMap;
     1.9 +#else
    1.10      typedef typename Digraph::template ArcMap<Value> FlowMap;
    1.11 +#endif
    1.12  
    1.13      /// \brief Instantiates a FlowMap.
    1.14      ///
    1.15 @@ -87,9 +91,12 @@
    1.16      ///
    1.17      /// The elevator type used by the algorithm.
    1.18      ///
    1.19 -    /// \sa Elevator
    1.20 -    /// \sa LinkedElevator
    1.21 +    /// \sa Elevator, LinkedElevator
    1.22 +#ifdef DOXYGEN
    1.23 +    typedef lemon::Elevator<GR, GR::Node> Elevator;
    1.24 +#else
    1.25      typedef lemon::Elevator<Digraph, typename Digraph::Node> Elevator;
    1.26 +#endif
    1.27  
    1.28      /// \brief Instantiates an Elevator.
    1.29      ///
    1.30 @@ -450,25 +457,27 @@
    1.31        return *_level;
    1.32      }
    1.33  
    1.34 -    /// \brief Sets the tolerance used by algorithm.
    1.35 +    /// \brief Sets the tolerance used by the algorithm.
    1.36      ///
    1.37 -    /// Sets the tolerance used by algorithm.
    1.38 -    Circulation& tolerance(const Tolerance& tolerance) const {
    1.39 +    /// Sets the tolerance object used by the algorithm.
    1.40 +    /// \return <tt>(*this)</tt>
    1.41 +    Circulation& tolerance(const Tolerance& tolerance) {
    1.42        _tol = tolerance;
    1.43        return *this;
    1.44      }
    1.45  
    1.46      /// \brief Returns a const reference to the tolerance.
    1.47      ///
    1.48 -    /// Returns a const reference to the tolerance.
    1.49 +    /// Returns a const reference to the tolerance object used by
    1.50 +    /// the algorithm.
    1.51      const Tolerance& tolerance() const {
    1.52 -      return tolerance;
    1.53 +      return _tol;
    1.54      }
    1.55  
    1.56      /// \name Execution Control
    1.57      /// The simplest way to execute the algorithm is to call \ref run().\n
    1.58 -    /// If you need more control on the initial solution or the execution,
    1.59 -    /// first you have to call one of the \ref init() functions, then
    1.60 +    /// If you need better control on the initial solution or the execution,
    1.61 +    /// you have to call one of the \ref init() functions first, then
    1.62      /// the \ref start() function.
    1.63  
    1.64      ///@{