COIN-OR::LEMON - Graph Library

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


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

Doc improvements

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/cost_scaling.h

    r2588 r2620  
    6565  ///
    6666  /// \author Peter Kovacs
    67 
    6867  template < typename Graph,
    6968             typename LowerMap = typename Graph::template EdgeMap<int>,
     
    103102    /// \brief Map adaptor class for handling residual edge costs.
    104103    ///
    105     /// \ref ResidualCostMap is a map adaptor class for handling
    106     /// residual edge costs.
     104    /// Map adaptor class for handling residual edge costs.
    107105    template <typename Map>
    108106    class ResidualCostMap : public MapBase<ResEdge, typename Map::Value>
     
    127125    /// \brief Map adaptor class for handling reduced edge costs.
    128126    ///
    129     /// \ref ReducedCostMap is a map adaptor class for handling reduced
    130     /// edge costs.
     127    /// Map adaptor class for handling reduced edge costs.
    131128    class ReducedCostMap : public MapBase<Edge, LCost>
    132129    {
     
    327324    }
    328325
    329     /// \brief Sets the flow map.
    330     ///
    331     /// Sets the flow map.
     326    /// \brief Set the flow map.
     327    ///
     328    /// Set the flow map.
    332329    ///
    333330    /// \return \c (*this)
     
    341338    }
    342339
    343     /// \brief Sets the potential map.
    344     ///
    345     /// Sets the potential map.
     340    /// \brief Set the potential map.
     341    ///
     342    /// Set the potential map.
    346343    ///
    347344    /// \return \c (*this)
     
    356353
    357354    /// \name Execution control
    358     /// The only way to execute the algorithm is to call the run()
    359     /// function.
    360355
    361356    /// @{
    362357
    363     /// \brief Runs the algorithm.
    364     ///
    365     /// Runs the algorithm.
     358    /// \brief Run the algorithm.
     359    ///
     360    /// Run the algorithm.
    366361    ///
    367362    /// \return \c true if a feasible flow can be found.
     
    374369    /// \name Query Functions
    375370    /// The result of the algorithm can be obtained using these
    376     /// functions.
    377     /// \n run() must be called before using them.
     371    /// functions.\n
     372    /// \ref lemon::CostScaling::run() "run()" must be called before
     373    /// using them.
    378374
    379375    /// @{
    380376
    381     /// \brief Returns a const reference to the edge map storing the
     377    /// \brief Return a const reference to the edge map storing the
    382378    /// found flow.
    383379    ///
    384     /// Returns a const reference to the edge map storing the found flow.
     380    /// Return a const reference to the edge map storing the found flow.
    385381    ///
    386382    /// \pre \ref run() must be called before using this function.
     
    389385    }
    390386
    391     /// \brief Returns a const reference to the node map storing the
     387    /// \brief Return a const reference to the node map storing the
    392388    /// found potentials (the dual solution).
    393389    ///
    394     /// Returns a const reference to the node map storing the found
     390    /// Return a const reference to the node map storing the found
    395391    /// potentials (the dual solution).
    396392    ///
     
    400396    }
    401397
    402     /// \brief Returns the flow on the given edge.
    403     ///
    404     /// Returns the flow on the given edge.
     398    /// \brief Return the flow on the given edge.
     399    ///
     400    /// Return the flow on the given edge.
    405401    ///
    406402    /// \pre \ref run() must be called before using this function.
     
    409405    }
    410406
    411     /// \brief Returns the potential of the given node.
    412     ///
    413     /// Returns the potential of the given node.
     407    /// \brief Return the potential of the given node.
     408    ///
     409    /// Return the potential of the given node.
    414410    ///
    415411    /// \pre \ref run() must be called before using this function.
     
    418414    }
    419415
    420     /// \brief Returns the total cost of the found flow.
    421     ///
    422     /// Returns the total cost of the found flow. The complexity of the
     416    /// \brief Return the total cost of the found flow.
     417    ///
     418    /// Return the total cost of the found flow. The complexity of the
    423419    /// function is \f$ O(e) \f$.
    424420    ///
     
    435431  private:
    436432
    437     /// Initializes the algorithm.
     433    /// Initialize the algorithm.
    438434    bool init() {
    439435      if (!_valid_supply) return false;
     
    470466
    471467
    472     /// Executes the algorithm.
     468    /// Execute the algorithm.
    473469    bool start() {
    474470      std::deque<Node> active_nodes;
Note: See TracChangeset for help on using the changeset viewer.