Enum MathError 

pub enum MathError {
    Singular,
    NotSpd,
    DimensionMismatch,
    NoConvergence,
    BracketNotStraddling,
}

Errors raised by the numerical primitives in math.

These are domain errors — every routine is a pure function and never panics on the inputs it accepts; “domain” means the input violates the algorithm’s preconditions (singular matrix, non-SPD matrix, bracket fails to straddle a root, etc.).

Examples

use regit_curves::math::MathError;

let err = MathError::Singular;
assert_eq!(format!("{err}"), "matrix is singular");

Variants

Singular

A pivot collapsed below tolerance during elimination — the matrix is singular (up to round-off).

NotSpd

Cholesky decomposition encountered a non-positive pivot — the matrix is not symmetric positive-definite.

DimensionMismatch

Inputs to a solver have inconsistent dimensions.

NoConvergence

Iterative algorithm did not converge to the requested tolerance within the iteration cap.

BracketNotStraddling

f(a) and f(b) do not straddle zero, so a bracketed root-finder cannot make progress.

Trait Implementations

impl Clone for MathError

fn clone(&self) -> MathError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MathError

impl Debug for MathError

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

Formats the value using the given formatter.

impl Display for MathError

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

Formats the value using the given formatter.

impl Eq for MathError

impl Error for MathError

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<MathError> for CurveError

fn from(e: MathError) -> Self

Converts to this type from the input type.

impl Hash for MathError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MathError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MathError