agi.foundation.numericalmethods

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

Enum GaussJacksonCorrectionMode

java.lang.Object

java.lang.Enum<GaussJacksonCorrectionMode>

agi.foundation.numericalmethods.GaussJacksonCorrectionMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<GaussJacksonCorrectionMode>

public enum GaussJacksonCorrectionMode
extends Enum<GaussJacksonCorrectionMode>
implements Enumeration

Indicates whether to use the full derivative function when computing corrections or whether to use only "fast" derivatives when computing corrections. For more details on "fast" and "slow" derivatives, see DependentVariableDerivatives.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL_CORRECTION Indicates full derivative information should be used to compute corrections.
PSEUDO_CORRECTION Indicates that only 'fast' derivatives should be used when computing corrections.

Method Summary

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

public static final GaussJacksonCorrectionMode FULL_CORRECTION

Indicates full derivative information should be used to compute corrections.

PSEUDO_CORRECTION

public static final GaussJacksonCorrectionMode PSEUDO_CORRECTION

Indicates that only 'fast' derivatives should be used when computing corrections.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.