Skip to main content

SolverError

Enum SolverError 

Source
#[non_exhaustive]
pub enum SolverError {
Show 13 variants DimensionMismatch { lhs: u32, rhs: u32, }, InvalidDimension, InvalidInput, NonFiniteInput, UnsupportedProblemStructure, SingularMatrix, IllConditioned, NumericalDomain, Overflow, WorkspaceTooSmall, Cancelled, BackendUnavailable, InternalInvariantViolation,
}
Expand description

Allocation-free, copyable error categories shared across every Loeres crate.

Marked #[non_exhaustive]: downstream matches must include a wildcard arm, so future solvers can add categories without a breaking change.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

DimensionMismatch

Two shapes that had to agree did not. Payloads are the mismatched extents.

Fields

§lhs: u32

Left-hand extent.

§rhs: u32

Right-hand extent.

§

InvalidDimension

A single dimension was itself invalid (e.g. zero where positive required).

§

InvalidInput

Input violated a declared domain or problem contract.

§

NonFiniteInput

A floating-like input was NaN or infinite.

§

UnsupportedProblemStructure

The problem is well-formed but unsupported by the selected solver/profile.

§

SingularMatrix

The system matrix was singular under the selected solver.

§

IllConditioned

Conditioning exceeded the solver’s declared stability threshold.

§

NumericalDomain

An operation would leave the solver’s valid numerical domain — division by zero, square root of a negative, or logarithm of a non-positive value.

§

Overflow

A checked scalar or storage operation overflowed.

§

WorkspaceTooSmall

The caller-provided workspace cannot hold the required scratch state.

§

Cancelled

A cluster cancellation token was observed.

§

BackendUnavailable

An optional backend was unavailable.

§

InternalInvariantViolation

A library invariant was violated — a bug, surfaced as an error rather than a panic so device callers can fail closed.

Implementations§

Source§

impl SolverError

Source

pub const fn is_input_error(self) -> bool

True for malformed caller input — bad dimensions, or non-finite / otherwise invalid values supplied to a public entry point.

Source

pub const fn is_numerical_error(self) -> bool

True for numerical failures encountered while solving.

Source

pub const fn is_resource_error(self) -> bool

True for resource / availability failures (workspace, cancellation, backend).

Trait Implementations§

Source§

impl Clone for SolverError

Source§

fn clone(&self) -> SolverError

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SolverError

Source§

impl Debug for SolverError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SolverError

Source§

impl PartialEq for SolverError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for SolverError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.