lemon-0.x: comparison lemon/min_mean

equal deleted inserted replaced

-:7c5686a40e4d
+:2cab37eb9ab5
 ///
 /// Runs the algorithm.
 ///
 /// \return \c true if a cycle exists in the graph.
 ///
-/// \note Apart from the return value, m.run() is just a shortcut
+/// \note Apart from the return value, <tt>m.run()</tt> is just a
-/// of the following code.
+/// shortcut of the following code.
 /// \code
 ///   m.init();
 ///   m.findMinMean();
 ///   m.findCycle();
 /// \endcode
 findMinMean();
 return findCycle();
 }
 /// \brief Initializes the internal data structures.
+///
+/// Initializes the internal data structures.
+///
+/// \sa reset()
 void init() {
 comp_num = stronglyConnectedComponents(graph, comp);
 if (!cycle_path) {
 	local_path = true;
 	cycle_path = new Path;
 /// \brief Resets the internal data structures.
 ///
 /// Resets the internal data structures so that \ref findMinMean()
 /// 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)
 	dmap[u].clear();
 cycle_node = INVALID;
 if (cycle_path) cycle_path->clear();
 /// \brief Returns the total length of the found cycle.
 ///
 /// 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;
 }
 /// \brief Returns the number of edges in the found cycle.
 ///
 /// 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;
 }
 /// \brief Returns the mean length of the found cycle.
 ///
 /// 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;
 }
 /// \brief Returns a const reference to the \ref lemon::Path "Path"

changeset 2522	616c019215c4
parent 2509	a8081c9cd96a
child 2529	93de38566e6c