agi.foundation.stoppingconditions

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

Enum WhenToCheckConstraint

java.lang.Object

java.lang.Enum<WhenToCheckConstraint>

agi.foundation.stoppingconditions.WhenToCheckConstraint

All Implemented Interfaces:

Enumeration, Serializable, Comparable<WhenToCheckConstraint>

public enum WhenToCheckConstraint
extends Enum<WhenToCheckConstraint>
implements Enumeration

An enumeration specifying when a StoppingConditionConstraint should be checked. Since the stopping conditions are usually numerically sampled, there is a moment when an event is detected, but not exactly found to within tolerance.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_EXACT_EVENT Check when an exact event has been found.
WHEN_EVENT_IS_DETECTED Check when an event is detected.

Method Summary

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

AT_EXACT_EVENT

public static final WhenToCheckConstraint AT_EXACT_EVENT

Check when an exact event has been found. If the constraint result may change between when an event is detected and when it is exactly found, then checking the constraints at the exact event will be more robust than checking when it is detected.

WHEN_EVENT_IS_DETECTED

public static final WhenToCheckConstraint WHEN_EVENT_IS_DETECTED

Check when an event is detected. If the constraint is not likely to be near its critical value when the condition is, then checking when a event is detected should prevent the stopping condition function from honing in on an exact event which can improve performance.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.