Skip to main content

StatsError

Enum StatsError 

Source
#[non_exhaustive]
pub enum StatsError { NotEnoughData { sample: &'static str, required: usize, found: usize, }, LengthMismatch { first: usize, second: usize, }, ProbabilityOutOfRange { value: f64, }, NotFinite { sample: &'static str, index: usize, value: f64, }, ParameterNotFinite { parameter: &'static str, value: f64, }, NonPositiveExpected { index: usize, value: f64, }, InvalidDegreesOfFreedom { freedom: f64, }, NonPositiveParameter { parameter: &'static str, value: f64, }, RankDeficientDesign, DidNotConverge { iterations: usize, }, }
Expand description

Errors reported by the checked (try_*) entry points of this crate.

Every panicking convenience wrapper (for example mean) simply unwraps its try_* twin, so a panic message is always the Display text of one of these variants.

Degenerate — but well defined — results are not errors. A sample with zero variance, or a perfectly flat predictor, yields a documented NaN/infinite statistic rather than an Err; see the individual functions for the exact convention.

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

NotEnoughData

The sample held fewer observations than the statistic requires.

Fields

§sample: &'static str

Name of the offending argument.

§required: usize

Minimum number of observations the statistic needs.

§found: usize

Number of observations actually supplied.

§

LengthMismatch

Two paired inputs had different lengths.

Fields

§first: usize

Length of the first argument.

§second: usize

Length of the second argument.

§

ProbabilityOutOfRange

A quantile probability was outside [0, 1] (or NaN).

Fields

§value: f64

The offending probability.

§

NotFinite

An observation was NaN or infinite.

Fields

§sample: &'static str

Name of the offending argument.

§index: usize

Index of the offending observation.

§value: f64

The offending value.

§

ParameterNotFinite

A scalar parameter (such as a hypothesised mean) was NaN or infinite.

Fields

§parameter: &'static str

Name of the offending parameter.

§value: f64

The offending value.

§

NonPositiveExpected

An expected cell count was zero or negative, so the chi-squared statistic would divide by zero.

Fields

§index: usize

Index of the offending category.

§value: f64

The offending value.

§

InvalidDegreesOfFreedom

The degrees of freedom implied by the inputs are not a usable distribution parameter (not finite, or not strictly positive).

Fields

§freedom: f64

The rejected degrees-of-freedom value.

§

NonPositiveParameter

A scalar parameter that must be strictly positive (such as a kernel bandwidth) was zero or negative.

Fields

§parameter: &'static str

Name of the offending parameter.

§value: f64

The offending value.

§

RankDeficientDesign

The regression design matrix does not have full column rank, so the coefficients are not identified.

§

DidNotConverge

An iterative fit did not settle within its iteration budget.

Fields

§iterations: usize

The number of iterations that were run.

Trait Implementations§

Source§

impl Clone for StatsError

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 Copy for StatsError

Source§

impl Debug for StatsError

Source§

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

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

impl Display for StatsError

Source§

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

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

impl Error for StatsError

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 StatsError

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 StatsError

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.