Enum FerroError 

#[non_exhaustive]
pub enum FerroError {
    ShapeMismatch {
        expected: Vec<usize>,
        actual: Vec<usize>,
        context: String,
    },
    InsufficientSamples {
        required: usize,
        actual: usize,
        context: String,
    },
    ConvergenceFailure {
        iterations: usize,
        message: String,
    },
    InvalidParameter {
        name: String,
        reason: String,
    },
    NumericalInstability {
        message: String,
    },
    IoError(Error),
    SerdeError {
        message: String,
    },
}

The unified error type for all ferrolearn operations.

Every public function in ferrolearn returns Result<T, FerroError>. The enum is #[non_exhaustive] so that new variants can be added in future minor releases without breaking downstream code.

Examples

use ferrolearn_core::FerroError;

let err = FerroError::ShapeMismatch {
    expected: vec![100, 10],
    actual: vec![100, 5],
    context: "feature matrix".into(),
};
assert!(err.to_string().contains("Shape mismatch"));

Variants (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.

ShapeMismatch

Array dimensions do not match the expected shape.

Fields

expected: Vec<usize>

The expected dimensions.

actual: Vec<usize>

The actual dimensions encountered.

context: String

Human-readable description of where the mismatch occurred.

InsufficientSamples

Not enough samples were provided for the requested operation.

Fields

required: usize

The minimum number of samples required.

actual: usize

The actual number of samples provided.

context: String

Human-readable description of the operation.

ConvergenceFailure

An iterative algorithm did not converge within the allowed iterations.

Fields

iterations: usize

The number of iterations that were attempted.

message: String

A description of the convergence issue.

InvalidParameter

A hyperparameter or configuration value is invalid.

Fields

name: String

The name of the parameter.

reason: String

Why the value is invalid.

NumericalInstability

A numerical computation produced NaN, infinity, or other instability.

Fields

message: String

A description of the numerical issue.

IoError(Error)

An I/O error occurred during data loading or model persistence.

SerdeError

A serialization or deserialization error occurred.

Fields

message: String

A description of the serialization issue.

Trait Implementations

impl Debug for FerroError

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

Formats the value using the given formatter.

impl Display for FerroError

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

Formats the value using the given formatter.

impl Error for FerroError

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 From<Error> for FerroError

fn from(source: Error) -> Self

Converts to this type from the input type.