numopt-js
    Preparing search index...

    Interface LbfgsOptions

    Options for L-BFGS (limited-memory BFGS).

    interface LbfgsOptions {
        historySize?: number;
        lineSearchOptions?: StrongWolfeLineSearchOptions;
        logLevel?: "DEBUG" | "INFO" | "WARN" | "ERROR";
        maxIterations?: number;
        onIteration?: (
            iteration: number,
            cost: number,
            parameters: Float64Array,
        ) => void;
        stepSize?: number;
        tolerance?: number;
        useLineSearch?: boolean;
        verbose?: boolean;
    }

    Hierarchy (View Summary)

    Index
    historySize? lineSearchOptions? logLevel? maxIterations? onIteration? stepSize? tolerance? useLineSearch? verbose?
    historySize?: number

    Maximum number of correction pairs to store. Default: 10

    lineSearchOptions?: StrongWolfeLineSearchOptions

    Options passed to Strong Wolfe line search.

    logLevel?: "DEBUG" | "INFO" | "WARN" | "ERROR"

    Log level for detailed logging output. Controls which log messages are displayed:

    • DEBUG: Detailed progress information (cost, gradient norm, step size, etc.)
    • INFO: Convergence messages and important state changes
    • WARN: Warnings (singular matrix, max iterations reached, line search failure, etc.)
    • ERROR: Fatal errors (currently not used, reserved for future extensions)

    If verbose is true and logLevel is not specified, logLevel defaults to INFO. If both logLevel and verbose are specified, logLevel takes precedence. Default: undefined (no logging)

    maxIterations?: number

    Maximum number of iterations before stopping. Default: 1000

    onIteration?: (
        iteration: number,
        cost: number,
        parameters: Float64Array,
    ) => void

    Callback function called at each iteration for progress monitoring. Useful for debugging and monitoring convergence.

    stepSize?: number

    Fixed step size used only when useLineSearch is false. Default: 1.0

    tolerance?: number

    Tolerance for convergence check (gradient norm, step size, etc.). Default: 1e-6

    Levenberg-Marquardt and constrained Levenberg-Marquardt prefer tolGradient / tolStep / tolResidual. If those are omitted, this value is used as a common fallback.

    useLineSearch?: boolean

    Whether to use Strong Wolfe line search. Default: true

    verbose?: boolean

    Enable verbose logging for debugging. When true, detailed information is logged to console. Default: false

    Use logLevel instead for more fine-grained control. If both logLevel and verbose are specified, logLevel takes precedence.

    Settings
    Member Visibility

    On This Page
    Properties