diff -r 30fb4d68b0e8 -r 8f41a3129746 lemon/cost_scaling.h --- a/lemon/cost_scaling.h Sun Oct 05 13:36:43 2008 +0000 +++ b/lemon/cost_scaling.h Sun Oct 05 13:37:17 2008 +0000 @@ -64,7 +64,6 @@ /// long int in the inside computations. /// /// \author Peter Kovacs - template < typename Graph, typename LowerMap = typename Graph::template EdgeMap, typename CapacityMap = typename Graph::template EdgeMap, @@ -102,8 +101,7 @@ /// \brief Map adaptor class for handling residual edge costs. /// - /// \ref ResidualCostMap is a map adaptor class for handling - /// residual edge costs. + /// Map adaptor class for handling residual edge costs. template class ResidualCostMap : public MapBase { @@ -126,8 +124,7 @@ /// \brief Map adaptor class for handling reduced edge costs. /// - /// \ref ReducedCostMap is a map adaptor class for handling reduced - /// edge costs. + /// Map adaptor class for handling reduced edge costs. class ReducedCostMap : public MapBase { private: @@ -326,9 +323,9 @@ delete _red_cost; } - /// \brief Sets the flow map. + /// \brief Set the flow map. /// - /// Sets the flow map. + /// Set the flow map. /// /// \return \c (*this) CostScaling& flowMap(FlowMap &map) { @@ -340,9 +337,9 @@ return *this; } - /// \brief Sets the potential map. + /// \brief Set the potential map. /// - /// Sets the potential map. + /// Set the potential map. /// /// \return \c (*this) CostScaling& potentialMap(PotentialMap &map) { @@ -355,14 +352,12 @@ } /// \name Execution control - /// The only way to execute the algorithm is to call the run() - /// function. /// @{ - /// \brief Runs the algorithm. + /// \brief Run the algorithm. /// - /// Runs the algorithm. + /// Run the algorithm. /// /// \return \c true if a feasible flow can be found. bool run() { @@ -373,25 +368,26 @@ /// \name Query Functions /// The result of the algorithm can be obtained using these - /// functions. - /// \n run() must be called before using them. + /// functions.\n + /// \ref lemon::CostScaling::run() "run()" must be called before + /// using them. /// @{ - /// \brief Returns a const reference to the edge map storing the + /// \brief Return a const reference to the edge map storing the /// found flow. /// - /// Returns a const reference to the edge map storing the found flow. + /// Return a const reference to the edge map storing the found flow. /// /// \pre \ref run() must be called before using this function. const FlowMap& flowMap() const { return *_flow; } - /// \brief Returns a const reference to the node map storing the + /// \brief Return a const reference to the node map storing the /// found potentials (the dual solution). /// - /// Returns a const reference to the node map storing the found + /// Return a const reference to the node map storing the found /// potentials (the dual solution). /// /// \pre \ref run() must be called before using this function. @@ -399,27 +395,27 @@ return *_potential; } - /// \brief Returns the flow on the given edge. + /// \brief Return the flow on the given edge. /// - /// Returns the flow on the given edge. + /// Return the flow on the given edge. /// /// \pre \ref run() must be called before using this function. Capacity flow(const Edge& edge) const { return (*_flow)[edge]; } - /// \brief Returns the potential of the given node. + /// \brief Return the potential of the given node. /// - /// Returns the potential of the given node. + /// Return the potential of the given node. /// /// \pre \ref run() must be called before using this function. Cost potential(const Node& node) const { return (*_potential)[node]; } - /// \brief Returns the total cost of the found flow. + /// \brief Return the total cost of the found flow. /// - /// Returns the total cost of the found flow. The complexity of the + /// Return the total cost of the found flow. The complexity of the /// function is \f$ O(e) \f$. /// /// \pre \ref run() must be called before using this function. @@ -434,7 +430,7 @@ private: - /// Initializes the algorithm. + /// Initialize the algorithm. bool init() { if (!_valid_supply) return false; @@ -469,7 +465,7 @@ } - /// Executes the algorithm. + /// Execute the algorithm. bool start() { std::deque active_nodes; typename Graph::template NodeMap hyper(_graph, false);