RhodeCode

    /// \ref init(), it will allocate a local \ref Path "path"

    /// 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.

    /// \note Apart from the return value, <tt>mmc.run()</tt> is just a

    /// shortcut of the following code.

    ///   mmc.init();

    ///   mmc.findMinMean();

    ///   mmc.findCycle();

      init();

    /// \brief Initialize the internal data structures.

    /// This function initializes the internal data structures.

    /// \sa reset()

    void init() {

    }

    /// \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

    /// \pre \ref init() and \ref findMinMean() must be called before

    /// using this function.

    /// The result of the algorithm can be obtained using these