agi.foundation.stoppingconditions

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

Enum StopType

java.lang.Object

java.lang.Enum<StopType>

agi.foundation.stoppingconditions.StopType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StopType>

public enum StopType
extends Enum<StopType>
implements Enumeration

An enumeration listing the possible events in a function that can be detected by a StoppingCondition.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY_EXTREMA Any extrema.
ANY_THRESHOLD Any threshold.
LOCAL_MAXIMUM A maximum.
LOCAL_MINIMUM A minimum.
THRESHOLD_DECREASING A threshold that is decreasing.
THRESHOLD_INCREASING A threshold that is increasing.

Method Summary

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

ANY_THRESHOLD

public static final StopType ANY_THRESHOLD

Any threshold.

THRESHOLD_INCREASING

public static final StopType THRESHOLD_INCREASING

A threshold that is increasing.

THRESHOLD_DECREASING

public static final StopType THRESHOLD_DECREASING

A threshold that is decreasing.

ANY_EXTREMA

public static final StopType ANY_EXTREMA

Any extrema.

LOCAL_MINIMUM

public static final StopType LOCAL_MINIMUM

A minimum.

LOCAL_MAXIMUM

public static final StopType LOCAL_MAXIMUM

A maximum.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.