COIN-OR::LEMON - Graph Library

Changeset 2620:8f41a3129746 in lemon-0.x for lemon/cycle_canceling.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/cycle_canceling.h

    r2593 r2620  
    6565  ///
    6666  /// \author Peter Kovacs
    67 
    6867  template < typename Graph,
    6968             typename LowerMap = typename Graph::template EdgeMap<int>,
     
    9998    /// \brief Map adaptor class for handling residual edge costs.
    10099    ///
    101     /// \ref ResidualCostMap is a map adaptor class for handling
    102     /// residual edge costs.
     100    /// Map adaptor class for handling residual edge costs.
    103101    class ResidualCostMap : public MapBase<ResEdge, Cost>
    104102    {
     
    279277    }
    280278
    281     /// \brief Sets the flow map.
    282     ///
    283     /// Sets the flow map.
     279    /// \brief Set the flow map.
     280    ///
     281    /// Set the flow map.
    284282    ///
    285283    /// \return \c (*this)
     
    293291    }
    294292
    295     /// \brief Sets the potential map.
    296     ///
    297     /// Sets the potential map.
     293    /// \brief Set the potential map.
     294    ///
     295    /// Set the potential map.
    298296    ///
    299297    /// \return \c (*this)
     
    308306
    309307    /// \name Execution control
    310     /// The only way to execute the algorithm is to call the run()
    311     /// function.
    312308
    313309    /// @{
    314310
    315     /// \brief Runs the algorithm.
    316     ///
    317     /// Runs the algorithm.
     311    /// \brief Run the algorithm.
     312    ///
     313    /// Run the algorithm.
    318314    ///
    319315    /// \param min_mean_cc Set this parameter to \c true to run the
     
    330326    /// \name Query Functions
    331327    /// The result of the algorithm can be obtained using these
    332     /// functions.
    333     /// \n run() must be called before using them.
     328    /// functions.\n
     329    /// \ref lemon::CycleCanceling::run() "run()" must be called before
     330    /// using them.
    334331
    335332    /// @{
    336333
    337     /// \brief Returns a const reference to the edge map storing the
     334    /// \brief Return a const reference to the edge map storing the
    338335    /// found flow.
    339336    ///
    340     /// Returns a const reference to the edge map storing the found flow.
     337    /// Return a const reference to the edge map storing the found flow.
    341338    ///
    342339    /// \pre \ref run() must be called before using this function.
     
    345342    }
    346343
    347     /// \brief Returns a const reference to the node map storing the
     344    /// \brief Return a const reference to the node map storing the
    348345    /// found potentials (the dual solution).
    349346    ///
    350     /// Returns a const reference to the node map storing the found
     347    /// Return a const reference to the node map storing the found
    351348    /// potentials (the dual solution).
    352349    ///
     
    356353    }
    357354
    358     /// \brief Returns the flow on the given edge.
    359     ///
    360     /// Returns the flow on the given edge.
     355    /// \brief Return the flow on the given edge.
     356    ///
     357    /// Return the flow on the given edge.
    361358    ///
    362359    /// \pre \ref run() must be called before using this function.
     
    365362    }
    366363
    367     /// \brief Returns the potential of the given node.
    368     ///
    369     /// Returns the potential of the given node.
     364    /// \brief Return the potential of the given node.
     365    ///
     366    /// Return the potential of the given node.
    370367    ///
    371368    /// \pre \ref run() must be called before using this function.
     
    374371    }
    375372
    376     /// \brief Returns the total cost of the found flow.
    377     ///
    378     /// Returns the total cost of the found flow. The complexity of the
     373    /// \brief Return the total cost of the found flow.
     374    ///
     375    /// Return the total cost of the found flow. The complexity of the
    379376    /// function is \f$ O(e) \f$.
    380377    ///
     
    391388  private:
    392389
    393     /// Initializes the algorithm.
     390    /// Initialize the algorithm.
    394391    bool init() {
    395392      if (!_valid_supply) return false;
     
    429426    }
    430427
    431     /// \brief Executes the algorithm using \ref BellmanFord.
    432     ///
    433     /// Executes the algorithm using the \ref BellmanFord
     428    /// \brief Execute the algorithm using \ref BellmanFord.
     429    ///
     430    /// Execute the algorithm using the \ref BellmanFord
    434431    /// "Bellman-Ford" algorithm for negative cycle detection with
    435432    /// successively larger limit for the number of iterations.
     
    507504    }
    508505
    509     /// \brief Executes the algorithm using \ref MinMeanCycle.
    510     ///
    511     /// Executes the algorithm using \ref MinMeanCycle for negative
     506    /// \brief Execute the algorithm using \ref MinMeanCycle.
     507    ///
     508    /// Execute the algorithm using \ref MinMeanCycle for negative
    512509    /// cycle detection.
    513510    void startMinMean() {
Note: See TracChangeset for help on using the changeset viewer.