Skip to main content

NumraError

Enum NumraError 

Source
#[non_exhaustive]
pub enum NumraError {
Show 18 variants Linalg(LinalgError), Convergence(ConvergenceError), InvalidInput(String), StepSizeTooSmall { h: f64, h_min: f64, }, MaxIterations { iterations: usize, max: usize, }, Stiffness { t: f64, message: String, }, EventTermination { t: f64, event_index: usize, }, NumericalOptim(OptimizationError), Ode(String), Optim(String), Ocp(String), Fit(String), Signal(String), LineSearch(String), Interp(String), Integrate(String), Special(String), Stats(String),
}
Expand description

Errors that can occur in Numra operations.

NumraError is the workspace-wide error type into which every fallible crate’s error converts via a From<…> for NumraError impl. This lets a user write solve_ode(...)?.integrate(...)?.fit(...)? and have ? work uniformly across crate boundaries.

Variants fall into two tiers:

The NumericalOptim variant wraps numra-core’s OptimizationError (line-search / descent / convergence failures that happen inside algorithms regardless of which crate hosts them); the Optim variant carries numra-optim::OptimError (the optimization crate’s API-level failures: missing objective, infeasibility, unbounded, etc.). The two are distinct concerns; do not confuse them.

NumraError is #[non_exhaustive]; new variants may be added in minor releases. Match arms must include a _ => … catch-all.

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

Linalg(LinalgError)

Linear algebra error from numra-linalg / numra-core.

§

Convergence(ConvergenceError)

Convergence failure from a Newton or fixed-point iteration.

§

InvalidInput(String)

Invalid input that doesn’t fit a more specific variant.

§

StepSizeTooSmall

Step size became too small.

Fields

§h_min: f64
§

MaxIterations

Maximum iterations exceeded.

Fields

§iterations: usize
§max: usize
§

Stiffness

Integration reached a singularity or stiffness.

Fields

§message: String
§

EventTermination

Event caused termination.

Fields

§event_index: usize
§

NumericalOptim(OptimizationError)

Numerical-optimization failure from inside an algorithm (line search, descent, convergence). See OptimizationError.

§

Ode(String)

ODE solver error from numra-ode.

§

Optim(String)

Optimization error from numra-optim (API-level failures).

§

Ocp(String)

ODE-constrained-optimization error from numra-ocp.

§

Fit(String)

Curve-fitting error from numra-fit.

§

Signal(String)

Signal-processing error from numra-signal.

§

LineSearch(String)

Line-search error from numra-nonlinear.

§

Interp(String)

Interpolation error from numra-interp.

§

Integrate(String)

Numerical-integration (quadrature) error from numra-integrate.

§

Special(String)

Special-function evaluation error from numra-special.

§

Stats(String)

Statistics error from numra-stats.

Trait Implementations§

Source§

impl Clone for NumraError

Source§

fn clone(&self) -> NumraError

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 NumraError

Source§

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

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

impl Display for NumraError

Source§

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

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

impl Error for NumraError

Available on crate feature std only.
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 From<ConvergenceError> for NumraError

Source§

fn from(e: ConvergenceError) -> Self

Converts to this type from the input type.
Source§

impl From<LinalgError> for NumraError

Source§

fn from(e: LinalgError) -> Self

Converts to this type from the input type.
Source§

impl From<OptimizationError> for NumraError

Source§

fn from(e: OptimizationError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for NumraError

Source§

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

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