agi.foundation.numericalmethods

(agi.foundation.core-2025r1.jar)

Enum InequalityBoundType

java.lang.Object

java.lang.Enum<InequalityBoundType>

agi.foundation.numericalmethods.InequalityBoundType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<InequalityBoundType>

public enum InequalityBoundType
extends Enum<InequalityBoundType>
implements Enumeration

Specifies whether the inequality function value must be greater than or equal to (lower bound) or less than or equal to (upper bound) the BoundValue (get / set).

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOWER_BOUND The inequality function value must be greater than or equal to the BoundValue (get / set) for the inequality to be considered to be satisfied.
UPPER_BOUND The inequality function value must be less than or equal to the BoundValue (get / set) for the inequality to be considered to be satisfied.

Method Summary

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

LOWER_BOUND

public static final InequalityBoundType LOWER_BOUND

The inequality function value must be greater than or equal to the BoundValue (get / set) for the inequality to be considered to be satisfied.

UPPER_BOUND

public static final InequalityBoundType UPPER_BOUND

The inequality function value must be less than or equal to the BoundValue (get / set) for the inequality to be considered to be satisfied.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.