agi.foundation.numericalmethods.advanced

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

Enum BrentSolutionType

java.lang.Object

java.lang.Enum<BrentSolutionType>

agi.foundation.numericalmethods.advanced.BrentSolutionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<BrentSolutionType>

public enum BrentSolutionType
extends Enum<BrentSolutionType>
implements Enumeration

Indicates on which side of zero a solution must be found.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE_OR_BELOW_ZERO Indicates that the solution may lie below, on, or above zero.
ON_OR_ABOVE_ZERO Indicates that the solution must lie on or above zero.
ON_OR_BELOW_ZERO Indicates that the solution must lie on or below zero.

Method Summary

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

ON_OR_BELOW_ZERO

public static final BrentSolutionType ON_OR_BELOW_ZERO

Indicates that the solution must lie on or below zero.

ABOVE_OR_BELOW_ZERO

public static final BrentSolutionType ABOVE_OR_BELOW_ZERO

Indicates that the solution may lie below, on, or above zero.

ON_OR_ABOVE_ZERO

public static final BrentSolutionType ON_OR_ABOVE_ZERO

Indicates that the solution must lie on or above zero.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.