# Changeset 2620:8f41a3129746 in lemon-0.x for lemon/cost_scaling.h

Ignore:
Timestamp:
10/05/08 15:37:17 (11 years ago)
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3505
Message:

Doc improvements

File:
1 edited

Unmodified
Added
Removed
• ## lemon/cost_scaling.h

 r2588 /// /// \author Peter Kovacs template < typename Graph, typename LowerMap = typename Graph::template EdgeMap, /// \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 /// \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 { } /// \brief Sets the flow map. /// /// Sets the flow map. /// \brief Set the flow map. /// /// Set the flow map. /// /// \return \c (*this) } /// \brief Sets the potential map. /// /// Sets the potential map. /// \brief Set the potential map. /// /// Set the potential map. /// /// \return \c (*this) /// \name Execution control /// The only way to execute the algorithm is to call the run() /// function. /// @{ /// \brief Runs the algorithm. /// /// Runs the algorithm. /// \brief Run the algorithm. /// /// Run the algorithm. /// /// \return \c true if a feasible flow can be found. /// \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. } /// \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). /// } /// \brief Returns the flow on the given edge. /// /// Returns the flow on the given edge. /// \brief Return the flow on the given edge. /// /// Return the flow on the given edge. /// /// \pre \ref run() must be called before using this function. } /// \brief Returns the potential of the given node. /// /// Returns the potential of the given node. /// \brief Return the potential of the given node. /// /// Return the potential of the given node. /// /// \pre \ref run() must be called before using this function. } /// \brief Returns the total cost of the found flow. /// /// Returns the total cost of the found flow. The complexity of the /// \brief Return the total cost of the found flow. /// /// Return the total cost of the found flow. The complexity of the /// function is \f$O(e) \f$. /// private: /// Initializes the algorithm. /// Initialize the algorithm. bool init() { if (!_valid_supply) return false; /// Executes the algorithm. /// Execute the algorithm. bool start() { std::deque active_nodes;
Note: See TracChangeset for help on using the changeset viewer.