agi.foundation.numericalmethods.advanced

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

Enum ThresholdCrossingSolutionType

java.lang.Object

java.lang.Enum<ThresholdCrossingSolutionType>

agi.foundation.numericalmethods.advanced.ThresholdCrossingSolutionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ThresholdCrossingSolutionType>

public enum ThresholdCrossingSolutionType
extends Enum<ThresholdCrossingSolutionType>
implements Enumeration

Indicates on which side of threshold crossing a solution must be found.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ON_ABOVE_OR_BELOW_THRESHOLD Indicates that the solution may lie below, on, or above the threshold.
ON_OR_ABOVE_THRESHOLD Indicates that the solution must lie on or above the threshold.
ON_OR_BELOW_THRESHOLD Indicates that the solution must lie on or below the threshold.

Method Summary

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

ON_OR_BELOW_THRESHOLD

public static final ThresholdCrossingSolutionType ON_OR_BELOW_THRESHOLD

Indicates that the solution must lie on or below the threshold.

ON_ABOVE_OR_BELOW_THRESHOLD

public static final ThresholdCrossingSolutionType ON_ABOVE_OR_BELOW_THRESHOLD

Indicates that the solution may lie below, on, or above the threshold.

ON_OR_ABOVE_THRESHOLD

public static final ThresholdCrossingSolutionType ON_OR_ABOVE_THRESHOLD

Indicates that the solution must lie on or above the threshold.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.