Enum MathError 

#[non_exhaustive]
pub enum MathError {
    Domain,
    DivisionByZero,
    InvalidArgument(&'static str),
    NotConverged(&'static str),
    DimensionMismatch,
    Overflow,
    Underflow,
    Singular,
    Timeout,
    Io,
    Parse,
    NotImplemented,
    OutOfRange,
    NoSolution,
    InfiniteSolutions,
    InvalidBase,
    NegativeInput,
}

Every failure mode MathVerse recognizes.

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.

Domain

Input outside the function’s domain (e.g. ln(-1)).

DivisionByZero

Division or modulus by zero.

InvalidArgument(&'static str)

A parameter was invalid; carries a human-readable reason.

NotConverged(&'static str)

An iterative method failed to converge.

DimensionMismatch

Matrix/vector shapes don’t line up.

Overflow

Result exceeded the representable range.

Underflow

Result fell below the representable range.

Singular

Matrix is not invertible.

Timeout

Computation exceeded a time or iteration limit.

Io

I/O operation failed.

Parse

Parsing of a string or expression failed.

NotImplemented

Feature or operation not yet implemented.

OutOfRange

Value outside a valid range.

NoSolution

No solution exists for the given inputs.

InfiniteSolutions

Infinitely many solutions exist.

InvalidBase

Base of a number system is invalid.

NegativeInput

Input must be non-negative.

Implementations

impl MathError

pub const fn msg(&self) -> &'static str

Returns a human-readable description of the error.

Examples

use mathverse_core::error::MathError;

assert_eq!(MathError::Domain.msg(), "input is outside the function domain");
assert_eq!(MathError::DivisionByZero.msg(), "division by zero");
assert_eq!(MathError::Overflow.msg(), "numeric overflow");

pub const fn has_context(&self) -> bool

Returns true if this error variant carries a custom message.

Examples

use mathverse_core::error::MathError;

assert!(MathError::InvalidArgument("bad").has_context());
assert!(!MathError::Domain.has_context());

Trait Implementations

impl Clone for MathError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

Available on crate feature std only.

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 String

fn from(e: MathError) -> String

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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MathError