COIN-OR::LEMON - Graph Library

Changeset 2517:d9cfac072869 in lemon-0.x for lemon/min_mean_cycle.h


Ignore:
Timestamp:
11/20/07 22:40:55 (13 years ago)
Author:
Peter Kovacs
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3393
Message:

Small changes in the documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/min_mean_cycle.h

    r2509 r2517  
    251251    /// \return \c true if a cycle exists in the graph.
    252252    ///
    253     /// \note Apart from the return value, m.run() is just a shortcut
    254     /// of the following code.
     253    /// \note Apart from the return value, <tt>m.run()</tt> is just a
     254    /// shortcut of the following code.
    255255    /// \code
    256256    ///   m.init();
     
    265265
    266266    /// \brief Initializes the internal data structures.
     267    ///
     268    /// Initializes the internal data structures.
     269    ///
     270    /// \sa reset()
    267271    void init() {
    268272      comp_num = stronglyConnectedComponents(graph, comp);
     
    342346    /// and \ref findCycle() can be called again (e.g. when the
    343347    /// underlaying graph has been modified).
     348    ///
     349    /// \sa init()
    344350    void reset() {
    345351      for (NodeIt u(graph); u != INVALID; ++u)
     
    354360    /// Returns the total length of the found cycle.
    355361    ///
    356     /// \pre \ref run() must be called before using this function.
     362    /// \pre \ref run() or \ref findCycle() must be called before
     363    /// using this function. If only \ref findMinMean() is called,
     364    /// the return value is not valid.
    357365    Length cycleLength() const {
    358366      return cycle_length;
     
    363371    /// Returns the number of edges in the found cycle.
    364372    ///
    365     /// \pre \ref run() must be called before using this function.
     373    /// \pre \ref run() or \ref findCycle() must be called before
     374    /// using this function. If only \ref findMinMean() is called,
     375    /// the return value is not valid.
    366376    int cycleEdgeNum() const {
    367377      return cycle_size;
     
    372382    /// Returns the mean length of the found cycle.
    373383    ///
    374     /// \pre \ref run() must be called before using this function.
     384    /// \pre \ref run() or \ref findMinMean() must be called before
     385    /// using this function.
    375386    ///
    376387    /// \warning LengthMap::Value must be convertible to double.
    377388    ///
    378     /// \note m.minMean() is just a shortcut of the following code.
     389    /// \note <tt>m.minMean()</tt> is just a shortcut of the following
     390    /// code.
    379391    /// \code
    380     ///   return m.cycleEdgeNum() / double(m.cycleLength());
     392    ///   return m.cycleLength() / double(m.cycleEdgeNum());
    381393    /// \endcode
     394    /// However if only \ref findMinMean() is called before using this
     395    /// function, <tt>m.cycleLength()</tt> and <tt>m.cycleEdgeNum()</tt>
     396    /// are not valid alone, only their ratio is valid.
    382397    double minMean() const {
    383398      return cycle_length / (double)cycle_size;
Note: See TracChangeset for help on using the changeset viewer.