agi.foundation.stoppingconditions

(agi.foundation.models-2024r3.jar)

Enum InequalityCondition

java.lang.Object

java.lang.Enum<InequalityCondition>

agi.foundation.stoppingconditions.InequalityCondition

All Implemented Interfaces:

Enumeration, Serializable, Comparable<InequalityCondition>

public enum InequalityCondition
extends Enum<InequalityCondition>
implements Enumeration

The criteria for comparing one value to another. Generally for use with constraints that use a threshold to determine if they are satisfied or not, like the ThresholdStoppingConditionConstraint.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUALS Does whatever value equal the threshold given.
GREATER_THAN Is the value greater than the threshold given.
GREATER_THAN_MINIMUM Is the value greater than the lowest value computed up to now.
GREATER_THAN_OR_EQUAL Is the value greater than or equal to the threshold given.
LESS_THAN Is the value less than the threshold given.
LESS_THAN_MAXIMUM Is the value less than the largest value computed up to now.
LESS_THAN_OR_EQUAL Is the value less than or equal to the threshold given.
NOT_EQUALS Does whatever value not equal the threshold given.

Method Summary

Modifier and Type	Method and Description
static InequalityCondition	getDefault() Get the enum constant that is considered to be the default.
static InequalityCondition	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static InequalityCondition	valueOf(String name) Returns the enum constant of this type with the specified name.
static InequalityCondition[]	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

EQUALS

public static final InequalityCondition EQUALS

Does whatever value equal the threshold given. When using this with a ThresholdStoppingConditionConstraint it is best to only use this option with something that is incremented slowly. A common error is to have the constraints InequalityCriteria (get / set) set to InequalityCondition.EQUALS, but the ThresholdStoppingConditionConstraint will only equal its threshold at one instant, and when the propagator happens to miss that exact spot, the propagation never stops.

NOT_EQUALS

public static final InequalityCondition NOT_EQUALS

Does whatever value not equal the threshold given.

GREATER_THAN

public static final InequalityCondition GREATER_THAN

Is the value greater than the threshold given.

GREATER_THAN_OR_EQUAL

public static final InequalityCondition GREATER_THAN_OR_EQUAL

Is the value greater than or equal to the threshold given.

GREATER_THAN_MINIMUM

public static final InequalityCondition GREATER_THAN_MINIMUM

Is the value greater than the lowest value computed up to now.

LESS_THAN

public static final InequalityCondition LESS_THAN

Is the value less than the threshold given.

LESS_THAN_OR_EQUAL

public static final InequalityCondition LESS_THAN_OR_EQUAL

Is the value less than or equal to the threshold given.

LESS_THAN_MAXIMUM

public static final InequalityCondition LESS_THAN_MAXIMUM

Is the value less than the largest value computed up to now.

Method Detail

values

public static InequalityCondition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InequalityCondition c : InequalityCondition.values())
    System.out.println(c);

Returns:

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

valueOf

public static InequalityCondition valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static InequalityCondition getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static InequalityCondition getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.