001/* A common interface for all the cycle existence 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
027//////////////////////////////////////////////////////////////////////////
028//// CycleExistenceAnalyzer
029
030/**
031 A common interface for all the cycle existence analyzers. Checks if
032 the graph under analysis has at least one cycle.
033 <p>
034 @see ptolemy.graph.analysis.CycleExistenceAnalysis
035 @since Ptolemy II 4.0
036 @Pt.ProposedRating Red (shahrooz)
037 @Pt.AcceptedRating Red (ssb)
038 @author Shahrooz Shahparnia
039 @version $Id$
040 */
041public interface CycleExistenceAnalyzer extends GraphAnalyzer {
042    /** Return true if the graph under analysis has at least one cycle.
043     *
044     *  @return True if the graph under analysis has at least one cycle.
045     */
046    public boolean hasCycle();
047}