Enum OptimizerError 

pub enum OptimizerError {
    LinearSolveFailed(String),
    MaxIterationsReached {
        max_iters: usize,
    },
    TrustRegionFailure {
        radius: f64,
        min_radius: f64,
    },
    DampingFailure {
        damping: f64,
        max_damping: f64,
    },
    CostIncrease {
        old_cost: f64,
        new_cost: f64,
    },
    JacobianFailed(String),
    InvalidParameters(String),
    NumericalInstability(String),
    LinAlg(LinAlgError),
    EmptyProblem,
    NoResidualBlocks,
    JacobiScalingCreation(String),
    JacobiScalingNotInitialized,
    UnknownLinearSolver(String),
}

Optimizer-specific error types for apex-solver

Variants

LinearSolveFailed(String)

Linear system solve failed during optimization

MaxIterationsReached

Maximum iterations reached without achieving convergence

Fields

max_iters: usize

TrustRegionFailure

Trust region radius became too small

Fields

radius: f64

min_radius: f64

DampingFailure

Damping parameter became too large (LM-specific)

Fields

damping: f64

max_damping: f64

CostIncrease

Cost increased unexpectedly when it should decrease

Fields

old_cost: f64

new_cost: f64

JacobianFailed(String)

Jacobian computation failed

InvalidParameters(String)

Invalid optimization parameters provided

NumericalInstability(String)

Numerical instability detected (NaN, Inf in cost, gradient, or parameters)

LinAlg(LinAlgError)

Linear algebra operation failed

EmptyProblem

Problem has no variables to optimize

NoResidualBlocks

Problem has no residual blocks

JacobiScalingCreation(String)

Jacobi scaling matrix creation failed

JacobiScalingNotInitialized

Jacobi scaling not initialized when expected

UnknownLinearSolver(String)

Unknown or unsupported linear solver type

Implementations

impl OptimizerError

pub fn log(self) -> Self

Log the error with tracing::error and return self for chaining

This method allows for a consistent error logging pattern throughout the optimizer module, ensuring all errors are properly recorded.

Example

operation()
    .map_err(|e| OptimizerError::from(e).log())?;

pub fn log_with_source<E: Debug>(self, source_error: E) -> Self

Log the error with the original source error from a third-party library

This method logs both the OptimizerError and the underlying error from external libraries. This provides full debugging context when errors occur in third-party code.

Arguments

• source_error - The original error from the third-party library (must implement Debug)

Example

SparseColMat::try_new_from_triplets(cols, cols, &triplets)
    .map_err(|e| {
        OptimizerError::JacobiScalingCreation(e.to_string())
            .log_with_source(e)
    })?;

Trait Implementations

impl Clone for OptimizerError

fn clone(&self) -> OptimizerError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OptimizerError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for OptimizerError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for OptimizerError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<LinAlgError> for OptimizerError

fn from(source: LinAlgError) -> Self

Converts to this type from the input type.

impl From<OptimizerError> for ApexSolverError

fn from(source: OptimizerError) -> Self

Converts to this type from the input type.