agi.foundation.stoppingconditions

(agi.foundation.models-2023r2.jar)

Enum StoppingConditionValueStatus

java.lang.Object

java.lang.Enum<StoppingConditionValueStatus>

agi.foundation.stoppingconditions.StoppingConditionValueStatus

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StoppingConditionValueStatus>

public enum StoppingConditionValueStatus
extends Enum<StoppingConditionValueStatus>
implements Enumeration

Indicates the value of the stopping condition relative to its threshold.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE_THRESHOLD The value computed by the StoppingCondition is above its threshold.
AT_THRESHOLD The value computed by the StoppingCondition is at its threshold plus or minus its tolerance.
BELOW_THRESHOLD The value computed by the StoppingCondition is below its threshold.
NOT_COMPUTED The StoppingCondition has not been evaluated yet and no determination of its status can be made or the condition is stopping on an extrema instead of a threshold.

Method Summary

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

ABOVE_THRESHOLD

public static final StoppingConditionValueStatus ABOVE_THRESHOLD

The value computed by the StoppingCondition is above its threshold.

AT_THRESHOLD

public static final StoppingConditionValueStatus AT_THRESHOLD

The value computed by the StoppingCondition is at its threshold plus or minus its tolerance.

BELOW_THRESHOLD

public static final StoppingConditionValueStatus BELOW_THRESHOLD

The value computed by the StoppingCondition is below its threshold.

NOT_COMPUTED

public static final StoppingConditionValueStatus NOT_COMPUTED

The StoppingCondition has not been evaluated yet and no determination of its status can be made or the condition is stopping on an extrema instead of a threshold.

Method Detail

values

public static StoppingConditionValueStatus[] 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 (StoppingConditionValueStatus c : StoppingConditionValueStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static StoppingConditionValueStatus 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 StoppingConditionValueStatus 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 StoppingConditionValueStatus getDefault()

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

Returns:

The default enum constant.