Package ptolemy.graph.analysis.analyzer

Interface CycleMeanAnalyzer

  • All Superinterfaces:
    Analyzer, GraphAnalyzer
    All Known Implementing Classes:
    KarpCycleMeanStrategy
    public interface CycleMeanAnalyzer
extends GraphAnalyzer
    A common interface for all the cycle mean analyzers.

    Since:
    Ptolemy II 4.0
    Version:
    $Id$
    Author:
    Shahrooz Shahparnia
    See Also:
    CycleMeanAnalysis
    Pt.AcceptedRating:
    Red (ssb)
    Pt.ProposedRating:
    Red (shahrooz)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List cycle()
      Return the nodes on the cycle that corresponds to the maximum/minimum cycle mean as an ordered list.
      double maximumCycleMean()
      Return the maximum cycle mean for a given directed graph.
      double minimumCycleMean()
      Return minimum cycle mean for a given directed graph.

    • Method Detail

      • cycle

        java.util.List cycle()
        Return the nodes on the cycle that corresponds to the maximum/minimum cycle mean as an ordered list. If there is more than one cycle with the same maximal/minimal cycle, one of them is returned randomly, but the same cycle is returned by different invocations of the method, unless the graph changes.
        Returns:
        The nodes on the cycle that corresponds to one of the maximum/minimum cycle means as an ordered list.

      • maximumCycleMean

        double maximumCycleMean()
        Return the maximum cycle mean for a given directed graph.
        Returns:
        The maximum cycle mean value.

      • minimumCycleMean

        double minimumCycleMean()
        Return minimum cycle mean for a given directed graph.
        Returns:
        The minimum cycle mean value.