Enum Error 

pub enum Error {
    LengthMismatch(usize, usize),
    Empty,
    NonFinite {
        idx: usize,
        value: f64,
    },
    Negative {
        idx: usize,
        value: f64,
    },
    NotNormalized {
        sum: f64,
    },
    InvalidAlpha {
        alpha: f64,
        forbidden: f64,
    },
    Domain(&'static str),
}

Errors for information-measure computations.

Variants

LengthMismatch(usize, usize)

Two input slices have different lengths (e.g., p and q in a divergence).

Empty

An input slice is empty where at least one element is required.

NonFinite

An entry is NaN or infinite where a finite value is required.

Fields

idx: usize

Position of the offending entry.

value: f64

The non-finite value found.

Negative

An entry is negative where a nonnegative value is required (probability distributions).

Fields

idx: usize

Position of the offending entry.

value: f64

The negative value found.

NotNormalized

The distribution does not sum to 1 within the specified tolerance.

Fields

sum: f64

Actual sum of the distribution.

InvalidAlpha

The alpha parameter is outside its valid domain (e.g., negative or non-finite).

Fields

alpha: f64

The invalid alpha value provided.

forbidden: f64

The value alpha must not equal (e.g., 0.0).

Domain(&'static str)

Catch-all for domain violations: zero standard deviation, q_i=0 while p_i>0, insufficient sample size for KSG, and similar precondition failures.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.