org.graalvm.compiler.core.common.calc

Enum Condition

java.lang.Object

java.lang.Enum<Condition>

org.graalvm.compiler.core.common.calc.Condition

All Implemented Interfaces:

Serializable, Comparable<Condition>

public enum Condition
extends Enum<Condition>

Condition codes used in conditionals.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Condition.CanonicalizedCondition

Enum Constant Summary

Enum Constants

Enum Constant and Description
AE Unsigned greater than or equal ("above than or equal").
AT Unsigned greater than ("above than").
BE Unsigned less than or equal ("below than or equal").
BT Unsigned less than ("below than").
EQ Equal.
GE Signed greater than or equal.
GT Signed greater than.
LE Signed less than or equal.
LT Signed less than.
NE Not equal.

Field Summary

Fields

Modifier and Type	Field and Description
String	operator

Method Summary

Modifier and Type	Method and Description
Condition.CanonicalizedCondition	canonicalize()
boolean	canonicalMirror() Returns true if the condition needs to be mirrored to get to a canonical condition.
boolean	canonicalNegate() Returns true if the condition needs to be negated to get to a canonical condition.
boolean	check(int left, int right)
boolean	foldCondition(Constant lt, Constant rt, ConstantReflectionProvider constantReflection, boolean unorderedIsTrue) Attempts to fold a comparison between two constants and return the result.
boolean	foldCondition(JavaConstant lt, JavaConstant rt, ConstantReflectionProvider constantReflection) Attempts to fold a comparison between two constants and return the result.
boolean	foldCondition(PrimitiveConstant lp, PrimitiveConstant rp, boolean unorderedIsTrue) Attempts to fold a comparison between two primitive constants and return the result.
boolean	implies(Condition other)
boolean	isCanonical() Given a condition and its negation, this method returns true for one of the two and false for the other one.
boolean	isCommutative() Checks if this conditional operation is commutative.
boolean	isUnsigned() Returns true if this condition represents an unsigned comparison.
Condition	join(Condition other) Return the join of this condition and other.
Condition	meet(Condition other)
Condition	mirror() Mirror this conditional (i.e.
Condition	negate() Negate this conditional.
boolean	trueIsDisjoint(Condition other) Returns true if this condition and other will never both return true for the same arguments.
static Condition	valueOf(String name) Returns the enum constant of this type with the specified name.
static Condition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EQ

public static final Condition EQ

Equal.

NE

public static final Condition NE

Not equal.

LT

public static final Condition LT

Signed less than.

LE

public static final Condition LE

Signed less than or equal.

GT

public static final Condition GT

Signed greater than.

GE

public static final Condition GE

Signed greater than or equal.

AE

public static final Condition AE

Unsigned greater than or equal ("above than or equal").

BE

public static final Condition BE

Unsigned less than or equal ("below than or equal").

AT

public static final Condition AT

Unsigned greater than ("above than").

BT

public static final Condition BT

Unsigned less than ("below than").

Field Detail

operator

public final String operator

Method Detail

values

public static Condition[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Condition valueOf(String name)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

check

public boolean check(int left,
                     int right)

canonicalize

public Condition.CanonicalizedCondition canonicalize()

isCanonical

public boolean isCanonical()

Given a condition and its negation, this method returns true for one of the two and false for the other one. This can be used to keep comparisons in a canonical form.

Returns:

true if this condition is considered to be the canonical form, false otherwise.

canonicalMirror

public boolean canonicalMirror()

Returns true if the condition needs to be mirrored to get to a canonical condition. The result of the mirroring operation might still need to be negated to achieve a canonical form.

canonicalNegate

public boolean canonicalNegate()

Returns true if the condition needs to be negated to get to a canonical condition. The result of the negation might still need to be mirrored to achieve a canonical form.

negate

public final Condition negate()

Negate this conditional.

Returns:

the condition that represents the negation

implies

public boolean implies(Condition other)

mirror

public final Condition mirror()

Mirror this conditional (i.e. commute "a op b" to "b op' a")

Returns:

the condition representing the equivalent commuted operation

isUnsigned

public final boolean isUnsigned()

Returns true if this condition represents an unsigned comparison. EQ and NE are not considered to be unsigned.

isCommutative

public final boolean isCommutative()

Checks if this conditional operation is commutative.

Returns:

true if this operation is commutative

foldCondition

public boolean foldCondition(JavaConstant lt,
                             JavaConstant rt,
                             ConstantReflectionProvider constantReflection)

Attempts to fold a comparison between two constants and return the result.

Parameters:

lt - the constant on the left side of the comparison

rt - the constant on the right side of the comparison

constantReflection - needed to compare constants

Returns:

Boolean.TRUE if the comparison is known to be true, Boolean.FALSE if the comparison is known to be false

foldCondition

public boolean foldCondition(Constant lt,
                             Constant rt,
                             ConstantReflectionProvider constantReflection,
                             boolean unorderedIsTrue)

Attempts to fold a comparison between two constants and return the result.

Parameters:

lt - the constant on the left side of the comparison

rt - the constant on the right side of the comparison

constantReflection - needed to compare constants

unorderedIsTrue - true if an undecided float comparison should result in "true"

Returns:

true if the comparison is known to be true, false if the comparison is known to be false

foldCondition

public boolean foldCondition(PrimitiveConstant lp,
                             PrimitiveConstant rp,
                             boolean unorderedIsTrue)

Attempts to fold a comparison between two primitive constants and return the result.

Parameters:

lp - the constant on the left side of the comparison

rp - the constant on the right side of the comparison

unorderedIsTrue - true if an undecided float comparison should result in "true"

Returns:

true if the comparison is known to be true, false if the comparison is known to be false

trueIsDisjoint

public boolean trueIsDisjoint(Condition other)

Returns true if this condition and other will never both return true for the same arguments. This means that tests using these conditions can be safely reordered.

join

public Condition join(Condition other)

Return the join of this condition and other. Only non-null return values are meaningful.

meet

public Condition meet(Condition other)