agi.foundation.numericalmethods.advanced

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

Enum NewtonRootType

java.lang.Object

java.lang.Enum<NewtonRootType>

agi.foundation.numericalmethods.advanced.NewtonRootType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<NewtonRootType>

public enum NewtonRootType
extends Enum<NewtonRootType>
implements Enumeration

Indicates the type of Root (get) held by a NewtonFindRoot.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FOUND_SOLUTION The root has a valid result after NewtonFindRoot.findRoot(int) has successfully run.
INITIAL_GUESS The value of the root has just been set as an initial guess and has yet to be solved for.
SOLUTION_DID_NOT_CONVERGE The attempt to solve for the location of the root failed as the solution did not converge in the allowed number of iterations.
SOLVER_FAILED_DUE_TO_HORIZONTAL_SLOPE The attempt to solve for the location of the root failed due to the derivative equaling zero, making a next guess impossible to calculate using this algorithm.

Method Summary

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

INITIAL_GUESS

public static final NewtonRootType INITIAL_GUESS

The value of the root has just been set as an initial guess and has yet to be solved for.

FOUND_SOLUTION

public static final NewtonRootType FOUND_SOLUTION

The root has a valid result after NewtonFindRoot.findRoot(int) has successfully run.

SOLUTION_DID_NOT_CONVERGE

public static final NewtonRootType SOLUTION_DID_NOT_CONVERGE

The attempt to solve for the location of the root failed as the solution did not converge in the allowed number of iterations. Root (get) holds the guess calculated by the latest iteration, and Iterations (get) holds the number iterations taken to calculate that latest guess.

SOLVER_FAILED_DUE_TO_HORIZONTAL_SLOPE

public static final NewtonRootType SOLVER_FAILED_DUE_TO_HORIZONTAL_SLOPE

The attempt to solve for the location of the root failed due to the derivative equaling zero, making a next guess impossible to calculate using this algorithm. You can try BrentFindRoot as an alternative method to solve for the root of your function. Root (get) contains the location of the guess which led to the zero derivative.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.