Enum NumericError

#[non_exhaustive]
pub enum NumericError {
    NonFiniteInput {
        name: &'static str,
    },
    NonFiniteEvaluation {
        name: &'static str,
        at: Option<f64>,
    },
    InvalidArgument {
        name: &'static str,
        reason: &'static str,
    },
    DimensionMismatch {
        name: &'static str,
        expected: usize,
        found: usize,
    },
    NoSignChange {
        f_lower: f64,
        f_upper: f64,
    },
    ZeroPolynomial,
    Singular {
        name: &'static str,
    },
    RankDeficient {
        name: &'static str,
        rank: usize,
        required: usize,
    },
    NotSymmetric {
        row: usize,
        column: usize,
    },
    NotPositiveDefinite {
        pivot: usize,
    },
    NotConverged {
        name: &'static str,
        error_estimate: f64,
    },
}

Why a numeric routine refused its input or could not produce a value.

Every variant names the offending argument or condition. A routine never substitutes a default, clamps silently, or returns NaN in place of one of these.

Variants (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.

NonFiniteInput

An input value was NaN or infinite. name is the argument.

Fields

name: &'static str

The argument that was not finite, such as "lower bound".

NonFiniteEvaluation

A caller-supplied function returned NaN or infinity.

Fields

name: &'static str

Which function, such as "integrand" or "residuals".

at: Option<f64>

The scalar argument it was evaluated at, when it has one.

InvalidArgument

An argument was finite but outside its valid range.

Fields

name: &'static str

The argument, such as "x tolerance".

reason: &'static str

What it must satisfy.

DimensionMismatch

Sizes of two arguments disagree.

Fields

name: &'static str

The argument whose size is wrong.

expected: usize

The size it must have.

found: usize

The size it has.

NoSignChange

The function has the same sign at both ends of the bracket, so a root is not guaranteed between them.

Fields

f_lower: f64

Value at the lower end.

f_upper: f64

Value at the upper end.

ZeroPolynomial

Every coefficient of the polynomial is zero: every point is a root.

Singular

A square matrix is singular to working precision.

Fields

name: &'static str

Which matrix, such as "system matrix".

RankDeficient

A least-squares matrix has fewer independent columns than unknowns, so the solution is not unique.

Fields

name: &'static str

Which matrix.

rank: usize

Numerical rank found.

required: usize

Rank required (the number of unknowns or constraints).

NotSymmetric

A matrix given to a symmetric solver is not symmetric.

Fields

row: usize

Row of the first asymmetric pair found.

column: usize

Column of the first asymmetric pair found.

NotPositiveDefinite

A symmetric matrix is not positive definite to working precision.

Fields

pivot: usize

Index of the first non-positive pivot.

NotConverged

An iterative routine stopped without meeting its tolerance. Returned only by the converged() accessors; the routines themselves report this case in their result’s status with the estimate they reached.

Fields

name: &'static str

Which routine.

error_estimate: f64

The error estimate it reached.

Trait Implementations

impl Clone for NumericError

fn clone(&self) -> NumericError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NumericError

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

Formats the value using the given formatter.

impl Display for NumericError

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

Formats the value using the given formatter.

impl Error for NumericError

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 PartialEq for NumericError

fn eq(&self, other: &NumericError) -> 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 StructuralPartialEq for NumericError