agi.foundation.numericalmethods.advanced

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

Enum ConvergenceCriteria

java.lang.Object

java.lang.Enum<ConvergenceCriteria>

agi.foundation.numericalmethods.advanced.ConvergenceCriteria

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ConvergenceCriteria>

public enum ConvergenceCriteria
extends Enum<ConvergenceCriteria>
implements Enumeration

Specifies the criteria to be used in determining convergence.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH Convergence in both the variable value and the function value is required.
EITHER Convergence in either the variable value or the function value is required.
FUNCTION Convergence in the function value is required.
VARIABLE Convergence in the variable value is required.

Method Summary

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

EITHER

public static final ConvergenceCriteria EITHER

Convergence in either the variable value or the function value is required.

VARIABLE

public static final ConvergenceCriteria VARIABLE

Convergence in the variable value is required.

FUNCTION

public static final ConvergenceCriteria FUNCTION

Convergence in the function value is required.

BOTH

public static final ConvergenceCriteria BOTH

Convergence in both the variable value and the function value is required.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.