agi.foundation.numericalmethods

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

Enum ExtremumType

java.lang.Object

java.lang.Enum<ExtremumType>

agi.foundation.numericalmethods.ExtremumType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ExtremumType>

public enum ExtremumType
extends Enum<ExtremumType>
implements Enumeration

Indicates whether an extremum is a minimum or a maximum.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAXIMUM Indicates that the extremum is a maximum.
MINIMUM Indicates that the extremum is a minimum.

Method Summary

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

MINIMUM

public static final ExtremumType MINIMUM

Indicates that the extremum is a minimum.

MAXIMUM

public static final ExtremumType MAXIMUM

Indicates that the extremum is a maximum.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.