net.mumie.mathletfactory.math.algebra.rel.node

Class SimpleRel

java.lang.Object

net.mumie.mathletfactory.math.algebra.AbstractTreeNode

net.mumie.mathletfactory.math.algebra.rel.node.RelNode

net.mumie.mathletfactory.math.algebra.rel.node.SimpleRel

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, NumberTypeDependentIF

public class SimpleRel
extends RelNode

This class represents an arbitrary "simple" relation (a relation that contains no logical connective like AND, OR, NOT) based on a dedicated number class. Basically it consists of three pieces of data, two net.mumie.mathletfactory.algebra.op.Operations for the left hand and right hand side and a relation sign, which is represented by a string and denotes the type of this relation ("=", ">", ">=", "!=", etc.).

Author:

Paehler

Document status:

finished

Field Summary

Fields

Modifier and Type	Field and Description
protected Operation	m_leftHandSide The left hand side operation of this simple relation.
protected int	m_normalForm This variable determines, whether this simple relation should be kept in normalized state and at which level. the possible values are net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_NONE, net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_REL, net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_OP and net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_OP_SEPARATED.
protected java.lang.String	m_relationSign The relation sign for this simple relation.
protected Operation	m_rightHandSide The right hand side operation of this simple relation.

Fields inherited from class net.mumie.mathletfactory.math.algebra.rel.node.RelNode

m_children, m_parent, m_relation

Fields inherited from class net.mumie.mathletfactory.math.algebra.AbstractTreeNode

m_numberClass

Constructor Summary

Constructors

Constructor and Description
SimpleRel(java.lang.Class numberClass, java.lang.String expression, int normalForm) Parses a simple relation from the given expression (should be something like "f(x,y,...) >= g(a,b,...)") and constructs it using normalForm as flag, whether the left and right hand side should be normalized.
SimpleRel(Operation leftHandSide, Operation rightHandSide, java.lang.String relationSign, int normalform) Constructs a simple relation from a given left and right hand side, a relation sign and a flag indicating, whether the left and right hand side should be normalized.
SimpleRel(Operation leftHandSide, java.lang.String relationSign) The Constructor for relations of type "expression > 0" , "expression = 0", etc.
SimpleRel(Operation leftHandSide, java.lang.String rightHandSide, java.lang.String relationSign) The Constructor for relations of type "expression > 0" , "expression = 0", etc.
SimpleRel(SimpleRel relation) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Returns the deep copied tree rooted by this node.
boolean	equals(java.lang.Object shouldBeASimpleRel) Two simple relations are considered equal if they both include each other.
boolean	evaluate(java.util.HashMap variableValues) Returns true if the given set of values satisfies the relation, false if not.
boolean	evaluate(MNumber[] assignedValues) Returns true if the given set of values assigned to the used variables (alphabetically sorted) satisfies the relation.
boolean	evaluateFast() Returns true if the relation represented by this node evaluates to true for the variable values already assigned.
int	getDepth(boolean opNodesCount) Returns the depth of the subtree rooted by this node.
Interval[]	getIntervalsFalse(double epsilon, Interval interval) Returns the set representation of the right hand side of negated version of this simple relation.
Interval[]	getIntervalsTrue(double epsilon, Interval interval) Returns the set representation of the right hand side of this simple relation.
Operation	getLeftHandSide() Returns the left hand side of this (in)equation.
int	getNormalForm() Returns whether the operations (left and right hand side) of this simple relation are in normal form.
java.lang.String	getRelationSign() Returns the relation Sign for this simple relation.
Operation	getRightHandSide() Returns the right hand side of this (in)equation.
java.util.HashSet	getUsedVariables(java.util.HashSet usedVariables) Returns all used variables as a HashSet of identifiers (Strings).
java.util.HashMap	getVariableOps() Returns a HashMap that contains the identifiers of all the used variables as keys and a list with the corresponding net.mumie.mathletfactory.algebra.op.node.VariableOps as values.
boolean	includes(SimpleRel aRel) Retursn true, if this simple relation logically includes the given simple relation, i.e.
boolean	isLeaf() Returns true if the node has no children.
RelNode	negate(boolean deepCopy) * logically negates this simple relation by replacing the relation sign with its counterpart (e.g. "=" is replaced with "!
SimpleRel	negated() Returns a new simple relation that is the logical negated equivalent of this simple relation.
void	normalizeOp()
void	parse(java.lang.String relationString) Sets this simple relation as the symbolic representation of the given string.
void	separateFor(java.lang.String string) Phantom implementation, should not be called.
void	setLeftHandSide(Operation leftHandSide) Sets the left hand side of this (in)equation.
void	setLeftHandSide(OpNode leftHandSide) Sets the left hand side of this (in)equation.
void	setNormalForm(int normalForm) Sets the operations (left and right hand side) of this simple relation to normal form.
void	setRelationSign(java.lang.String sign) Sets the relation Sign for this simple relation.
void	setRightHandSide(Operation rightHandSide) Sets the right hand side of this (in)equation.
void	setRightHandSide(OpNode rightHandSide) Sets the right hand side of this (in)equation.
java.lang.String	toString() Returns the String representation of this simple relation.
java.lang.String	toString(java.text.DecimalFormat format) The string representation with respect to the given decimal format.

Methods inherited from class net.mumie.mathletfactory.math.algebra.rel.node.RelNode

children, compareTo, extractNode, getChildren, getFalseFor, getFirstChildOfType, getParent, getRelation, getSimpleRelations, getSubrelations, getTrueFor, insertNode, insertNodes, parent, parenthesesNeeded, setChildren, setChildren, setParent, setParent, setRelation

Methods inherited from class net.mumie.mathletfactory.math.algebra.AbstractTreeNode

contains, extractNode, getDepth, getNumberClass, insertNode, replace, replaceByValue, replaceWith

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_leftHandSide

protected Operation m_leftHandSide

The left hand side operation of this simple relation.

m_rightHandSide

protected Operation m_rightHandSide

The right hand side operation of this simple relation.

m_normalForm

protected int m_normalForm

This variable determines, whether this simple relation should be kept in normalized state and at which level. the possible values are net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_NONE, net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_REL, net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_OP and net.mumie.mathletfactory.algebra.rel.Relation#NORMALIZE_OP_SEPARATED.

m_relationSign

protected java.lang.String m_relationSign

The relation sign for this simple relation. It may have one of the constant values specified in net.mumie.mathletfactory.algebra.rel.Relation.

Constructor Detail

SimpleRel

public SimpleRel(java.lang.Class numberClass,
         java.lang.String expression,
         int normalForm)

Parses a simple relation from the given expression (should be something like "f(x,y,...) >= g(a,b,...)") and constructs it using normalForm as flag, whether the left and right hand side should be normalized.

SimpleRel

public SimpleRel(Operation leftHandSide,
         Operation rightHandSide,
         java.lang.String relationSign,
         int normalform)

Constructs a simple relation from a given left and right hand side, a relation sign and a flag indicating, whether the left and right hand side should be normalized.

SimpleRel

public SimpleRel(SimpleRel relation)

Copy constructor.

SimpleRel

public SimpleRel(Operation leftHandSide,
         java.lang.String relationSign)

The Constructor for relations of type "expression > 0" , "expression = 0", etc.

SimpleRel

public SimpleRel(Operation leftHandSide,
         java.lang.String rightHandSide,
         java.lang.String relationSign)

The Constructor for relations of type "expression > 0" , "expression = 0", etc.

Method Detail

setLeftHandSide

public void setLeftHandSide(Operation leftHandSide)

Sets the left hand side of this (in)equation.

setLeftHandSide

public void setLeftHandSide(OpNode leftHandSide)

Sets the left hand side of this (in)equation.

setRightHandSide

public void setRightHandSide(Operation rightHandSide)

Sets the right hand side of this (in)equation.

setRightHandSide

public void setRightHandSide(OpNode rightHandSide)

Sets the right hand side of this (in)equation.

setRelationSign

public void setRelationSign(java.lang.String sign)

Sets the relation Sign for this simple relation.

getRelationSign

public java.lang.String getRelationSign()

Returns the relation Sign for this simple relation.

getLeftHandSide

public Operation getLeftHandSide()

Returns the left hand side of this (in)equation.

getRightHandSide

public Operation getRightHandSide()

Returns the right hand side of this (in)equation.

separateFor

public void separateFor(java.lang.String string)

Phantom implementation, should not be called.

Specified by:

separateFor in class RelNode

parse

public void parse(java.lang.String relationString)

Sets this simple relation as the symbolic representation of the given string.

evaluate

public boolean evaluate(MNumber[] assignedValues)

Returns true if the given set of values assigned to the used variables (alphabetically sorted) satisfies the relation.

Throws:

java.lang.IllegalArgumentException - if not all the variables are assigend with values.

evaluate

public boolean evaluate(java.util.HashMap variableValues)

Returns true if the given set of values satisfies the relation, false if not.

Specified by:

evaluate in class RelNode

Parameters:

variableValues - a mapping of identifiers (Strings) to values (MMNumbers)

Throws:

java.lang.IllegalArgumentException - if not all the variables are assigend with values.

evaluateFast

public boolean evaluateFast()

Description copied from class: RelNode

Returns true if the relation represented by this node evaluates to true for the variable values already assigned.

Specified by:

evaluateFast in class RelNode

See Also:

net.mumie.mathletfactory.algebra.rel.Relation#evaluateFast

getUsedVariables

public java.util.HashSet getUsedVariables(java.util.HashSet usedVariables)

Returns all used variables as a HashSet of identifiers (Strings).

Specified by:

getUsedVariables in class RelNode

getVariableOps

public java.util.HashMap getVariableOps()

Returns a HashMap that contains the identifiers of all the used variables as keys and a list with the corresponding net.mumie.mathletfactory.algebra.op.node.VariableOps as values.

toString

public java.lang.String toString(java.text.DecimalFormat format)

The string representation with respect to the given decimal format.

Specified by:

toString in class RelNode

toString

public java.lang.String toString()

Returns the String representation of this simple relation.

Overrides:

toString in class java.lang.Object

setNormalForm

public void setNormalForm(int normalForm)

Sets the operations (left and right hand side) of this simple relation to normal form.

Specified by:

setNormalForm in class RelNode

normalizeOp

public void normalizeOp()

negate

public RelNode negate(boolean deepCopy)

* logically negates this simple relation by replacing the relation sign with its counterpart (e.g. "=" is replaced with "!=", ">" with "<=", etc.).

Specified by:

negate in class RelNode

Parameters:

deepCopy - true if the complete relation tree should be deep copied otherwise only the top node will be new.

See Also:

net.mumie.mathletfactory.algebra.rel.node.RelNode#negate(boolean)

negated

public SimpleRel negated()

Returns a new simple relation that is the logical negated equivalent of this simple relation.

See Also:

negate(boolean)

getNormalForm

public int getNormalForm()

Returns whether the operations (left and right hand side) of this simple relation are in normal form.

Specified by:

getNormalForm in class RelNode

getDepth

public int getDepth(boolean opNodesCount)

Returns the depth of the subtree rooted by this node. If opNodesCount is set to true, the net.mumie.mathletfactory.algebra.op.node.OpNodes do of SimpleRels also count as tree nodes.

Overrides:

getDepth in class RelNode

See Also:

net.mumie.mathletfactory.algebra.rel.node.RelNode#getDepth(boolean)

isLeaf

public boolean isLeaf()

Description copied from class: RelNode

Returns true if the node has no children.

Specified by:

isLeaf in class RelNode

clone

public java.lang.Object clone()

Returns the deep copied tree rooted by this node.

Overrides:

clone in class RelNode

getIntervalsTrue

public Interval[] getIntervalsTrue(double epsilon,
                          Interval interval)

Returns the set representation of the right hand side of this simple relation.

Specified by:

getIntervalsTrue in class RelNode

getIntervalsFalse

public Interval[] getIntervalsFalse(double epsilon,
                           Interval interval)

Returns the set representation of the right hand side of negated version of this simple relation.

Specified by:

getIntervalsFalse in class RelNode

includes

public boolean includes(SimpleRel aRel)

Retursn true, if this simple relation logically includes the given simple relation, i.e. that this relation follows from the given relation (e.g. a<=b includes a

equals

public boolean equals(java.lang.Object shouldBeASimpleRel)

Two simple relations are considered equal if they both include each other.

Overrides:

equals in class RelNode

See Also:

includes(net.mumie.mathletfactory.math.algebra.rel.node.SimpleRel)