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

Timestamp:

11/20/07 22:40:55 (17 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:

• lemon/min_mean_cycle.h (modified) (6 diffs)

lemon/min_mean_cycle.h

@@ -251 +251 @@
     /// \return \c true if a cycle exists in the graph.
     ///
-    /// \note Apart from the return value, m.run() is just a shortcut
-    /// of the following code.
+    /// \note Apart from the return value, <tt>m.run()</tt> is just a
+    /// shortcut of the following code.
     /// \code
     ///   m.init();
@@ -265 +265 @@
 
     /// \brief Initializes the internal data structures.
+    ///
+    /// Initializes the internal data structures.
+    ///
+    /// \sa reset()
     void init() {
       comp_num = stronglyConnectedComponents(graph, comp);
@@ -342 +346 @@
     /// and \ref findCycle() can be called again (e.g. when the
     /// underlaying graph has been modified).
+    ///
+    /// \sa init()
     void reset() {
       for (NodeIt u(graph); u != INVALID; ++u)
@@ -354 +360 @@
     /// Returns the total length of the found cycle.
     ///
-    /// \pre \ref run() must be called before using this function.
+    /// \pre \ref run() or \ref findCycle() must be called before
+    /// using this function. If only \ref findMinMean() is called,
+    /// the return value is not valid.
     Length cycleLength() const {
       return cycle_length;
@@ -363 +371 @@
     /// Returns the number of edges in the found cycle.
     ///
-    /// \pre \ref run() must be called before using this function.
+    /// \pre \ref run() or \ref findCycle() must be called before
+    /// using this function. If only \ref findMinMean() is called,
+    /// the return value is not valid.
     int cycleEdgeNum() const {
       return cycle_size;
@@ -372 +382 @@
     /// Returns the mean length of the found cycle.
     ///
-    /// \pre \ref run() must be called before using this function.
+    /// \pre \ref run() or \ref findMinMean() must be called before
+    /// using this function.
     ///
     /// \warning LengthMap::Value must be convertible to double.
     ///
-    /// \note m.minMean() is just a shortcut of the following code.
+    /// \note <tt>m.minMean()</tt> is just a shortcut of the following
+    /// code.
     /// \code
-    ///   return m.cycleEdgeNum() / double(m.cycleLength());
+    ///   return m.cycleLength() / double(m.cycleEdgeNum());
     /// \endcode
+    /// However if only \ref findMinMean() is called before using this
+    /// function, <tt>m.cycleLength()</tt> and <tt>m.cycleEdgeNum()</tt>
+    /// are not valid alone, only their ratio is valid.
     double minMean() const {
       return cycle_length / (double)cycle_size;