numopt-js
    Preparing search index...

    Interface AdjointDerivativeOptions

    Analytical or finite-difference knobs shared by reduced-space adjoint solvers. ∂c/∂x must be square so that x(p) is locally unique.

    interface AdjointDerivativeOptions {
        constraintTolerance?: number;
        dcdp?: (parameters: Float64Array, states: Float64Array) => Matrix;
        dcdx?: (parameters: Float64Array, states: Float64Array) => Matrix;
        dfdp?: (parameters: Float64Array, states: Float64Array) => Float64Array;
        dfdx?: (parameters: Float64Array, states: Float64Array) => Float64Array;
        regularization?: number;
        stepSizeP?: number;
        stepSizeX?: number;
    }

    Hierarchy (View Summary)

    Index
    constraintTolerance? dcdp? dcdx? dfdp? dfdx? regularization? stepSizeP? stepSizeX?
    constraintTolerance?: number

    Tolerance for ||c(p, x)|| = 0. Default: 1e-6

    dcdp?: (parameters: Float64Array, states: Float64Array) => Matrix

    Analytical ∂c/∂p. Size constraintCount × parameterCount.

    dcdx?: (parameters: Float64Array, states: Float64Array) => Matrix

    Analytical ∂c/∂x. Must be square (constraintCount === stateCount). Ill-conditioned Jacobians can be sensitive; raise regularization if needed.

    dfdp?: (parameters: Float64Array, states: Float64Array) => Float64Array

    Analytical ∂f/∂p. Used instead of finite differences when provided.

    dfdx?: (parameters: Float64Array, states: Float64Array) => Float64Array

    Analytical ∂f/∂x. Used instead of finite differences when provided.

    regularization?: number

    Base Tikhonov regularization for solves involving ∂c/∂x. Default: 0 (an automatic floor may still apply when the Jacobian is singular)

    stepSizeP?: number

    Finite-difference step for derivatives with respect to parameters. Default: 1e-6

    stepSizeX?: number

    Finite-difference step for derivatives with respect to states. Default: 1e-6

    Settings
    Member Visibility

    On This Page
    Properties