Enum StatsError 

pub enum StatsError {
    EmptyInput {
        metric: &'static str,
    },
    InsufficientInput {
        metric: &'static str,
        minimum: usize,
        actual: usize,
    },
    NonFinite {
        metric: &'static str,
        index: Option<usize>,
        value: f64,
    },
    ProbabilityOutOfRange {
        metric: &'static str,
        index: Option<usize>,
        value: f64,
    },
    ProbabilityMass {
        metric: &'static str,
        sum: f64,
    },
    ZeroEvidence {
        metric: &'static str,
    },
    ZeroTotal {
        label: &'static str,
    },
    ZeroReferenceRate {
        metric: &'static str,
    },
}

Errors returned by probability, statistics, and fairness helpers.

Each variant carries the metric name of the helper that rejected the input, so the failure can be reported without the caller tracking context.

Variants

EmptyInput

A helper requiring at least one value was given an empty slice.

Fields

metric: &'static str

Name of the helper that rejected the input.

InsufficientInput

Fewer values were supplied than the helper requires.

Fields

metric: &'static str

Name of the helper that rejected the input.

minimum: usize

Smallest number of values the helper accepts.

actual: usize

Number of values actually supplied.

NonFinite

A value was not finite (NaN or infinite).

Fields

metric: &'static str

Name of the helper that rejected the input.

index: Option<usize>

Position of the offending value, if it came from a slice.

value: f64

The offending value.

ProbabilityOutOfRange

A probability fell outside the closed range 0.0..=1.0.

Fields

metric: &'static str

Name of the helper that rejected the input.

index: Option<usize>

Position of the offending value, if it came from a slice.

value: f64

The offending value.

ProbabilityMass

A probability vector did not sum to one within tolerance.

Fields

metric: &'static str

Name of the helper that rejected the input.

sum: f64

The actual sum of the probabilities.

ZeroEvidence

A Bayesian update was given zero total evidence.

Fields

metric: &'static str

Name of the helper that rejected the input.

ZeroTotal

A counts pair was given a zero total.

Fields

label: &'static str

Label of the count whose total was zero.

ZeroReferenceRate

A fairness ratio was given a zero reference rate to divide by.

Fields

metric: &'static str

Name of the helper that rejected the input.

Trait Implementations

impl Clone for StatsError

fn clone(&self) -> StatsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatsError

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

Formats the value using the given formatter.

impl Display for StatsError

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

Formats the value using the given formatter.

impl Error for StatsError

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 StatsError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StatsError