Package de.labathome.trustconstr.records

Class FiniteDifferenceOptions

java.lang.Object

de.labathome.trustconstr.records.FiniteDifferenceOptions

public final class FiniteDifferenceOptions
extends Object

Configuration for NumDiff.approxDerivative(java.util.function.DoubleUnaryOperator, double, de.labathome.trustconstr.records.FiniteDifferenceOptions). Build via FiniteDifferenceOptions.FiniteDifferenceOptionsFactory (chained setters then FiniteDifferenceOptions.FiniteDifferenceOptionsFactory.build()).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FiniteDifferenceOptions.FiniteDifferenceOptionsFactory	Builder for FiniteDifferenceOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final FiniteDifferenceOptions.FiniteDifferenceOptionsFactory	FACTORY	Default factory; build via FiniteDifferenceOptions.FiniteDifferenceOptionsFactory.build().

Method Summary

Modifier and Type	Method	Description
Matrix	absStep()
boolean	asLinearOperator()
FiniteDifferenceBounds	bounds()
FiniteDifferenceMethod	method()
Matrix	relStep()
Sparsity	sparsity()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FACTORY

public static final FiniteDifferenceOptions.FiniteDifferenceOptionsFactory FACTORY

Default factory; build via FiniteDifferenceOptions.FiniteDifferenceOptionsFactory.build().

Method Details

method

public FiniteDifferenceMethod method()

Returns:

the FD scheme

relStep

public Matrix relStep()

Returns:

per-variable relative step size, or null

absStep

public Matrix absStep()

Returns:

per-variable absolute step size, or null

bounds

public FiniteDifferenceBounds bounds()

Returns:

bounds within which FD perturbations must stay

asLinearOperator

public boolean asLinearOperator()

Returns:

whether the result should be a LinearOperator rather than a materialised matrix

sparsity

public Sparsity sparsity()

Returns:

Jacobian sparsity hint, or null for dense FD