Skip to main content

StatlaError

Enum StatlaError 

Source
#[non_exhaustive]
pub enum StatlaError { Dimension { what: &'static str, expected: usize, found: usize, }, InvalidArgument { what: &'static str, }, NonFinite { what: &'static str, index: usize, }, NotPositiveDefinite { column: usize, }, DowndateIndefinite { margin: f64, }, RankDeficient { column: usize, }, NoConvergence { requested: usize, converged: usize, restarts: usize, }, Operator(OperatorError), Lu(LuError), Kkt(KktError), }
Expand description

Everything that can go wrong, for every function of the crate (decision S10: one error type). No function of the crate panics on bad input; panics are bugs.

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.
§

Dimension

Two lengths that must agree do not.

Fields

§what: &'static str

Which argument has the wrong length.

§expected: usize

Expected length.

§found: usize

Actual length.

§

InvalidArgument

An argument outside its domain: an index out of range, a view whose ld < rows, a matrix that is not square, an option out of its range, …

Fields

§what: &'static str

What is wrong, in a few words.

§

NonFinite

A NaN or an infinity in the input.

Fields

§what: &'static str

Which argument.

§index: usize

Position (column-major for matrices).

§

NotPositiveDefinite

Cholesky factorization met a nonpositive pivot at column (the matrix is not positive definite within CholOptions::pivot_tol).

Fields

§column: usize

The column of the failing pivot.

§

DowndateIndefinite

A downdate A − x xᵀ would not be positive definite: with Rᵀa = x, 1 − ‖a‖² ≤ CholOptions::downdate_tol (step C2 of 12.2). The factor is unchanged (H3).

Fields

§margin: f64

1 − ‖a‖² as computed (≤ the tolerance; may be negative; −∞ if it overflowed).

§

RankDeficient

Qr met a column (or, in delete_row, a complement vector) whose norm fell below QrOptions::rank_tol after reorthogonalization.

Fields

§column: usize

The column concerned (for delete_row, the index of the row that could not be deleted).

§

NoConvergence

Fewer than requested values converged within the restart limit (and allow_partial of the options is off).

Fields

§requested: usize

k.

§converged: usize

How many satisfied the convergence test.

§restarts: usize

Restarts performed.

§

Operator(OperatorError)

The caller’s operator reported an error.

§

Lu(LuError)

The LU of A − σI failed (shift-invert, crate::ShiftInvert); σ is probably an eigenvalue.

§

Kkt(KktError)

The LDLᵀ of A − σI failed (crate::SymShiftInvert); a [KktError::WrongInertia] with zero pivots means σ is (numerically) an eigenvalue.

Trait Implementations§

Source§

impl Clone for StatlaError

Source§

fn clone(&self) -> Self

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 Debug for StatlaError

Source§

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

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

impl Display for StatlaError

Source§

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

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

impl Error for StatlaError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl PartialEq for StatlaError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StatlaError

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.