agi.foundation.numericalmethods.advanced

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

Enum BracketToward

java.lang.Object

java.lang.Enum<BracketToward>

agi.foundation.numericalmethods.advanced.BracketToward

All Implemented Interfaces:

Enumeration, Serializable, Comparable<BracketToward>

public enum BracketToward
extends Enum<BracketToward>
implements Enumeration

Defines the behavior of a root finder such as BrentFindRoot when a sampled function value exactly equals zero and the root finder's ConvergenceCriteria requires convergence on the independent variable.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EARLIEST The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a smaller independent variable value.
LATEST The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a larger independent variable value.
NEGATIVE The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a negative sampled function value.
POSITIVE The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a positive sampled function value.

Method Summary

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

EARLIEST

public static final BracketToward EARLIEST

The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a smaller independent variable value. The identified root will represent the first time (within tolerance) that the function is zero.

LATEST

public static final BracketToward LATEST

The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a larger independent variable value. The identified root will represent the last time (within tolerance) that the function is zero.

POSITIVE

public static final BracketToward POSITIVE

The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a positive sampled function value. The identified root will represent the first time (within tolerance) that the function is zero after being negative, or the last time that it is zero before going negative.

NEGATIVE

public static final BracketToward NEGATIVE

The new bracket will be formed from the just-sampled zero and the side of the previous bracket with a negative sampled function value. The identified root will represent the first time (within tolerance) that the function is zero after being positive, or the last time that it is zero before going positive.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.