1.1 --- a/lemon/circulation.h Thu Dec 10 17:05:35 2009 +0100
1.2 +++ b/lemon/circulation.h Thu Dec 10 17:18:25 2009 +0100
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 @@ -299,7 +306,7 @@
1.31 /// The Elevator should have standard constructor interface to be
1.32 /// able to automatically created by the algorithm (i.e. the
1.33 /// digraph and the maximum level should be passed to it).
1.34 - /// However an external elevator object could also be passed to the
1.35 + /// However, an external elevator object could also be passed to the
1.36 /// algorithm with the \ref elevator(Elevator&) "elevator()" function
1.37 /// before calling \ref run() or \ref init().
1.38 /// \sa SetElevator
1.39 @@ -450,25 +457,27 @@
1.40 return *_level;
1.41 }
1.42
1.43 - /// \brief Sets the tolerance used by algorithm.
1.44 + /// \brief Sets the tolerance used by the algorithm.
1.45 ///
1.46 - /// Sets the tolerance used by algorithm.
1.47 - Circulation& tolerance(const Tolerance& tolerance) const {
1.48 + /// Sets the tolerance object used by the algorithm.
1.49 + /// \return <tt>(*this)</tt>
1.50 + Circulation& tolerance(const Tolerance& tolerance) {
1.51 _tol = tolerance;
1.52 return *this;
1.53 }
1.54
1.55 /// \brief Returns a const reference to the tolerance.
1.56 ///
1.57 - /// Returns a const reference to the tolerance.
1.58 + /// Returns a const reference to the tolerance object used by
1.59 + /// the algorithm.
1.60 const Tolerance& tolerance() const {
1.61 - return tolerance;
1.62 + return _tol;
1.63 }
1.64
1.65 /// \name Execution Control
1.66 /// The simplest way to execute the algorithm is to call \ref run().\n
1.67 - /// If you need more control on the initial solution or the execution,
1.68 - /// first you have to call one of the \ref init() functions, then
1.69 + /// If you need better control on the initial solution or the execution,
1.70 + /// you have to call one of the \ref init() functions first, then
1.71 /// the \ref start() function.
1.72
1.73 ///@{