Package de.labathome.trustconstr.enums

Enum Class FiniteDifferenceMethod

java.lang.Object

java.lang.Enum<FiniteDifferenceMethod>

de.labathome.trustconstr.enums.FiniteDifferenceMethod

All Implemented Interfaces:

Serializable, Comparable<FiniteDifferenceMethod>, Constable

public enum FiniteDifferenceMethod
extends Enum<FiniteDifferenceMethod>

Finite-difference scheme used by NumDiff.approxDerivative(java.util.function.DoubleUnaryOperator, double, de.labathome.trustconstr.records.FiniteDifferenceOptions).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLEX_STEP	Complex-step differentiation (scipy 'cs').
ONE_SIDED	One-sided perturbation (forward or backward, picked per dimension).
THREE_POINT	Central difference (scipy '3-point').
TWO_POINT	Forward difference (scipy '2-point').
TWO_SIDED	Two-sided central perturbation.

Method Summary

Modifier and Type	Method	Description
static FiniteDifferenceMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FiniteDifferenceMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TWO_POINT

public static final FiniteDifferenceMethod TWO_POINT

Forward difference (scipy '2-point').

ONE_SIDED

public static final FiniteDifferenceMethod ONE_SIDED

One-sided perturbation (forward or backward, picked per dimension).

THREE_POINT

public static final FiniteDifferenceMethod THREE_POINT

Central difference (scipy '3-point').

TWO_SIDED

public static final FiniteDifferenceMethod TWO_SIDED

Two-sided central perturbation.

COMPLEX_STEP

public static final FiniteDifferenceMethod COMPLEX_STEP

Complex-step differentiation (scipy 'cs'). Not yet implemented.

Method Details

values

public static FiniteDifferenceMethod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static FiniteDifferenceMethod valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null