Package de.labathome.trustconstr.records

Class FiniteDifferenceOptions.FiniteDifferenceOptionsFactory

java.lang.Object

de.labathome.trustconstr.records.FiniteDifferenceOptions.FiniteDifferenceOptionsFactory

Enclosing class:

FiniteDifferenceOptions

public static class FiniteDifferenceOptions.FiniteDifferenceOptionsFactory
extends Object

Builder for FiniteDifferenceOptions.

Constructor Summary

Constructors

Constructor	Description
FiniteDifferenceOptionsFactory()	Default-construct a fresh factory (THREE_POINT, unbounded).

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

FiniteDifferenceOptionsFactory

public FiniteDifferenceOptionsFactory()

Default-construct a fresh factory (THREE_POINT, unbounded).

Method Details

method

public FiniteDifferenceOptions.FiniteDifferenceOptionsFactory method(FiniteDifferenceMethod method)

Parameters:

method - FD scheme to use

Returns:

this factory, for chaining

relStep

public FiniteDifferenceOptions.FiniteDifferenceOptionsFactory relStep(Matrix relStep)

Parameters:

relStep - per-variable relative step size; may be null to derive a default from machine epsilon

Returns:

this factory, for chaining

absStep

public FiniteDifferenceOptions.FiniteDifferenceOptionsFactory absStep(Matrix absStep)

Parameters:

absStep - per-variable absolute step size; takes precedence over relStep(Matrix) when set

Returns:

this factory, for chaining

bounds

public FiniteDifferenceOptions.FiniteDifferenceOptionsFactory bounds(FiniteDifferenceBounds bounds)

Parameters:

bounds - box bounds within which FD perturbations must stay

Returns:

this factory, for chaining

Throws:

RuntimeException - if called more than once

asLinearOperator

public FiniteDifferenceOptions.FiniteDifferenceOptionsFactory asLinearOperator(boolean asLinearOperator)

Parameters:

asLinearOperator - if true, return the FD Jacobian as a LinearOperator instead of materialising the full matrix

Returns:

this factory, for chaining

sparsity

public FiniteDifferenceOptions.FiniteDifferenceOptionsFactory sparsity(Sparsity sparsity)

Parameters:

sparsity - Jacobian sparsity hint enabling Curtis-Powell-Reid column grouping (mass-evaluating columns whose sparsity patterns are row-disjoint)

Returns:

this factory, for chaining

build

public FiniteDifferenceOptions build()

Returns:

a fresh FiniteDifferenceOptions with the configured fields