001/* A common interface for all the cycle mean analyzers.
002
003 Copyright (c) 2003-2005 The University of Maryland.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF MARYLAND BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF MARYLAND HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF MARYLAND SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 MARYLAND HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 */
025package ptolemy.graph.analysis.analyzer;
026
027import java.util.List;
028
029//////////////////////////////////////////////////////////////////////////
030//// CycleMeanAnalyzer
031
032/**
033 A common interface for all the cycle mean analyzers.
034 <p>
035 @see ptolemy.graph.analysis.CycleMeanAnalysis
036 @since Ptolemy II 4.0
037 @Pt.ProposedRating Red (shahrooz)
038 @Pt.AcceptedRating Red (ssb)
039 @author Shahrooz Shahparnia
040 @version $Id$
041 */
042public interface CycleMeanAnalyzer extends GraphAnalyzer {
043    /** Return the nodes on the cycle that corresponds to the maximum/minimum
044     *  cycle mean as an ordered list. If there is more than one cycle with the
045     *  same maximal/minimal cycle, one of them is returned randomly,
046     *  but the same cycle is returned by different invocations of the method,
047     *  unless the graph changes.
048     *
049     *  @return The nodes on the cycle that corresponds to one of the
050     *  maximum/minimum cycle means as an ordered list.
051     */
052    public List cycle();
053
054    /** Return the maximum cycle mean for a given directed graph.
055     *
056     *  @return The maximum cycle mean value.
057     */
058    public double maximumCycleMean();
059
060    /** Return minimum cycle mean for a given directed graph.
061     *
062     *  @return The minimum cycle mean value.
063     */
064    public double minimumCycleMean();
065}