agi.foundation.numericalmethods

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

Enum DerivativeMode

java.lang.Object

java.lang.Enum<DerivativeMode>

agi.foundation.numericalmethods.DerivativeMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<DerivativeMode>

public enum DerivativeMode
extends Enum<DerivativeMode>
implements Enumeration

An enumeration indicating the mode in which to calculate derivatives. This is used by certain integrators to optimize performance by only computing "principal" derivatives at points in an algorithm where approximations can be made without much error while improving performance. "Perturbation" derivatives are then held constant instead of reevaluating potentially expensive computations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL_EVALUATION Compute both fast and slow derivatives.
PERTURBATION_EVALUATION Compute all remaining derivatives not included when computing the "fast" derivatives.
PRINCIPAL_EVALUATION Compute only those derivatives that are most important and quick to compute.

Method Summary

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

FULL_EVALUATION

public static final DerivativeMode FULL_EVALUATION

Compute both fast and slow derivatives.

PRINCIPAL_EVALUATION

public static final DerivativeMode PRINCIPAL_EVALUATION

Compute only those derivatives that are most important and quick to compute.

PERTURBATION_EVALUATION

public static final DerivativeMode PERTURBATION_EVALUATION

Compute all remaining derivatives not included when computing the "fast" derivatives. These usually include derivatives which take longer to compute but don't account for as much of the dynamics as the "fast" derivatives.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.