Enum StatsError 

pub enum StatsError {
    InvalidInput {
        message: String,
    },
    ConversionError {
        message: String,
    },
    EmptyData {
        message: String,
    },
    DimensionMismatch {
        message: String,
    },
    NumericalError {
        message: String,
    },
    NotFitted {
        message: String,
    },
    InvalidParameter {
        message: String,
    },
    IndexOutOfBounds {
        message: String,
    },
    MathematicalError {
        message: String,
    },
}

Main error type for the rs-stats library

This enum represents all possible errors that can occur in the library. Each variant includes a message providing context about the error.

Examples

use rs_stats::error::{StatsError, StatsResult};

fn example() -> StatsResult<f64> {
    Err(StatsError::InvalidInput {
        message: "Value must be positive".to_string(),
    })
}

Variants

InvalidInput

Invalid input parameters provided to a function

Fields

message: String

Human-readable error message

ConversionError

Type conversion failure

Fields

message: String

Human-readable error message

EmptyData

Empty data provided when data is required

Fields

message: String

Human-readable error message

DimensionMismatch

Dimension mismatch between arrays/vectors

Fields

message: String

Human-readable error message

NumericalError

Numerical computation error (overflow, underflow, NaN, etc.)

Fields

message: String

Human-readable error message

NotFitted

Model not fitted/trained before use

Fields

message: String

Human-readable error message

InvalidParameter

Invalid parameter value

Fields

message: String

Human-readable error message

IndexOutOfBounds

Index out of bounds

Fields

message: String

Human-readable error message

MathematicalError

Division by zero or similar mathematical error

Fields

message: String

Human-readable error message

Implementations

impl StatsError

pub fn invalid_input<S: Into<String>>(message: S) -> Self

Create an InvalidInput error

pub fn conversion_error<S: Into<String>>(message: S) -> Self

Create a ConversionError

pub fn empty_data<S: Into<String>>(message: S) -> Self

Create an EmptyData error

pub fn dimension_mismatch<S: Into<String>>(message: S) -> Self

Create a DimensionMismatch error

pub fn numerical_error<S: Into<String>>(message: S) -> Self

Create a NumericalError

pub fn not_fitted<S: Into<String>>(message: S) -> Self

Create a NotFitted error

pub fn invalid_parameter<S: Into<String>>(message: S) -> Self

Create an InvalidParameter error

pub fn index_out_of_bounds<S: Into<String>>(message: S) -> Self

Create an IndexOutOfBounds error

pub fn mathematical_error<S: Into<String>>(message: S) -> Self

Create a MathematicalError

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, __formatter: &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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StatsError