ptolemy.graph
Class Inequality

java.lang.Object
  extended byptolemy.graph.Inequality

public class Inequality
extends java.lang.Object

An inequality over a CPO. Each inequality consists of two InequalityTerms, the lesser term and the greater term. The relation between them is less than or equal to. In addition, an inequality keeps a list of variables in it. The variables are InequalityTerms that consist of a single variable.

Since:
Ptolemy II 0.2
Version:
$Id: Inequality.java,v 1.41 2004/04/13 03:40:37 cxh Exp $
Author:
Yuhong Xiong
See Also:
InequalityTerm
Accepted Rating:
Green (kienhuis)
Proposed Rating:
Green (yuhong)

Constructor Summary
Inequality(InequalityTerm lesserTerm, InequalityTerm greaterTerm)
          Construct an inequality.
 
Method Summary
 InequalityTerm getGreaterTerm()
          Return the greater term of this inequality.
 InequalityTerm getLesserTerm()
          Return the lesser term of this inequality.
 boolean isSatisfied(CPO cpo)
          Test if this inequality is satisfied with the current value of variables.
 java.lang.String toString()
          Override the base class to describe the inequality.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Inequality

public Inequality(InequalityTerm lesserTerm,
                  InequalityTerm greaterTerm)
Construct an inequality.

Parameters:
lesserTerm - An InequalityTerm that is less than or equal to the second argument.
greaterTerm - An InequalityTerm that is greater than or equal to the first argument.
Throws:
java.lang.IllegalArgumentException - If the lesserTerm or the greaterTerm is null.
Method Detail

getGreaterTerm

public InequalityTerm getGreaterTerm()
Return the greater term of this inequality.

Returns:
An InequalityTerm

getLesserTerm

public InequalityTerm getLesserTerm()
Return the lesser term of this inequality.

Returns:
An InequalityTerm

isSatisfied

public boolean isSatisfied(CPO cpo)
                    throws IllegalActionException
Test if this inequality is satisfied with the current value of variables.

Parameters:
cpo - A CPO over which this inequality is defined.
Returns:
True if this inequality is satisfied; false otherwise.
Throws:
IllegalActionException

toString

public java.lang.String toString()
Override the base class to describe the inequality.

Returns:
A string describing the inequality.