Enum SolverError 

pub enum SolverError {
    Cost(&'static str),
    NotFiniteComputation(&'static str),
    ProjectionFailed(&'static str),
    LinearAlgebraFailure(&'static str),
    InvalidProblemState(&'static str),
}

Exceptions/errors that may arise while solving a problem.

In the Rust API, numerical failures are generally reported through Result<_, SolverError>:

• user-provided callbacks may return SolverError::Cost,
• set projections may return SolverError::ProjectionFailed,
• non-finite intermediate values are reported via SolverError::NotFiniteComputation, and
• internal numerical/kernel issues are reported through SolverError::LinearAlgebraFailure or SolverError::InvalidProblemState.

By contrast, blatant API misuse such as inconsistent slice dimensions may still panic in some low-level routines.

Variants

Cost(&'static str)

If the gradient or cost function cannot be evaluated

NotFiniteComputation(&'static str)

Computation failed and NaN/Infinite value was obtained

ProjectionFailed(&'static str)

A projection could not be computed numerically

LinearAlgebraFailure(&'static str)

A linear algebra operation failed

InvalidProblemState(&'static str)

The solver reached an unexpected internal state

Trait Implementations

impl Clone for SolverError

fn clone(&self) -> SolverError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SolverError

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

Formats the value using the given formatter.

impl Display for SolverError

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

Formats the value using the given formatter.

impl Error for SolverError

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<CholeskyError> for SolverError

fn from(_: CholeskyError) -> Self

Converts to this type from the input type.

impl From<MatrixError> for SolverError

fn from(_: MatrixError) -> Self

Converts to this type from the input type.

impl PartialEq for SolverError

fn eq(&self, other: &SolverError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SolverError

impl Eq for SolverError

impl StructuralPartialEq for SolverError