agi.foundation.numericalmethods.advanced

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

Enum ExtremumKind

java.lang.Object

java.lang.Enum<ExtremumKind>

agi.foundation.numericalmethods.advanced.ExtremumKind

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ExtremumKind>

public enum ExtremumKind
extends Enum<ExtremumKind>
implements Enumeration

Enumerates possible extremum types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID Did not return a valid extremum.
MAXIMUM Extremum is a maximum of the function.
MINIMUM Extremum is a minimum of the function.

Method Summary

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

Extremum is a minimum of the function.

INVALID

public static final ExtremumKind INVALID

Did not return a valid extremum.

MAXIMUM

public static final ExtremumKind MAXIMUM

Extremum is a maximum of the function.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.