Changeset 806:d66ff32624e2 in lemon

Timestamp:

08/03/09 14:35:38 (15 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Simplify the interface of MinMeanCycle? (#179)
Remove init() and reset(), and move their content into findMinMean().

File:

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

lemon/min_mean_cycle.h

@@ -123 +123 @@
     ///
     /// If you don't call this function before calling \ref run() or
-    /// \ref init(), it will allocate a local \ref Path "path"
+    /// \ref findMinMean(), it will allocate a local \ref Path "path"
     /// structure. The destuctor deallocates this automatically
     /// allocated object, of course.
@@ -145 +145 @@
     /// The simplest way to execute the algorithm is to call the \ref run()
     /// function.\n
-    /// If you only need the minimum mean length, you may call \ref init()
-    /// and \ref findMinMean().
-    /// If you would like to run the algorithm again (e.g. the underlying
-    /// digraph and/or the arc lengths has been modified), you may not
-    /// create a new instance of the class, rather call \ref reset(),
-    /// \ref findMinMean() and \ref findCycle() instead.
+    /// If you only need the minimum mean length, you may call
+    /// \ref findMinMean().
 
     /// @{
@@ -157 +153 @@
     ///
     /// This function runs the algorithm.
+    /// It can be called more than once (e.g. if the underlying digraph
+    /// and/or the arc lengths have been modified).
     ///
     /// \return \c true if a directed cycle exists in the digraph.
     ///
-    /// \note Apart from the return value, <tt>mmc.run()</tt> is just a
-    /// shortcut of the following code.
+    /// \note <tt>mmc.run()</tt> is just a shortcut of the following code.
     /// \code
-    ///   mmc.init();
-    ///   mmc.findMinMean();
-    ///   mmc.findCycle();
+    ///   return mmc.findMinMean() && mmc.findCycle();
     /// \endcode
     bool run() {
-      init();
       return findMinMean() && findCycle();
     }
 
-    /// \brief Initialize the internal data structures.
-    ///
-    /// This function initializes the internal data structures.
-    ///
-    /// \sa reset()
-    void init() {
+    /// \brief Find the minimum cycle mean.
+    ///
+    /// This function finds the minimum mean length of the directed
+    /// cycles in the digraph.
+    ///
+    /// \return \c true if a directed cycle exists in the digraph.
+    bool findMinMean() {
+      // Initialize
       _tol.epsilon(1e-6);
       if (!_cycle_path) {
@@ -183 +179 @@
         _cycle_path = new Path;
       }
+      _cycle_path->clear();
       _cycle_found = false;
+
+      // Find the minimum cycle mean in the components
       _comp_num = stronglyConnectedComponents(_gr, _comp);
-    }
-
-    /// \brief Reset the internal data structures.
-    ///
-    /// This function resets the internal data structures so that
-    /// findMinMean() and findCycle() can be called again (e.g. when the
-    /// underlying digraph and/or the arc lengths has been modified).
-    ///
-    /// \sa init()
-    void reset() {
-      if (_cycle_path) _cycle_path->clear();
-      _cycle_found = false;
-      _comp_num = stronglyConnectedComponents(_gr, _comp);
-    }
-
-    /// \brief Find the minimum cycle mean.
-    ///
-    /// This function computes all the required data and finds the
-    /// minimum mean length of the directed cycles in the digraph.
-    ///
-    /// \return \c true if a directed cycle exists in the digraph.
-    ///
-    /// \pre \ref init() must be called before using this function.
-    bool findMinMean() {
-      // Find the minimum cycle mean in the components
       for (int comp = 0; comp < _comp_num; ++comp) {
         if (!initCurrentComponent(comp)) continue;
@@ -228 +202 @@
     /// \return \c true if a directed cycle exists in the digraph.
     ///
-    /// \pre \ref init() and \ref findMinMean() must be called before
-    /// using this function.
+    /// \pre \ref findMinMean() must be called before using this function.
     bool findCycle() {
       if (!_cycle_found) return false;
@@ -243 +216 @@
 
     /// \name Query Functions
-    /// The result of the algorithm can be obtained using these
+    /// The results of the algorithm can be obtained using these
     /// functions.\n
     /// The algorithm should be executed before using them.