Enum FerrayError 

#[non_exhaustive]
pub enum FerrayError {
    ShapeMismatch {
        message: String,
    },
    BroadcastFailure {
        shape_a: Vec<usize>,
        shape_b: Vec<usize>,
    },
    AxisOutOfBounds {
        axis: usize,
        ndim: usize,
    },
    IndexOutOfBounds {
        index: isize,
        axis: usize,
        size: usize,
    },
    SingularMatrix {
        message: String,
    },
    ConvergenceFailure {
        iterations: usize,
        message: String,
    },
    InvalidDtype {
        message: String,
    },
    NumericalInstability {
        message: String,
    },
    IoError {
        message: String,
    },
    InvalidValue {
        message: String,
    },
}

The primary error type for all ferray operations.

This enum is #[non_exhaustive], so new variants may be added in minor releases without breaking downstream code.

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

Operand shapes are incompatible for the requested operation.

Fields

message: String

Human-readable description of the mismatch.

BroadcastFailure

Broadcasting failed because shapes cannot be reconciled.

Fields

shape_a: Vec<usize>

First shape.

shape_b: Vec<usize>

Second shape.

AxisOutOfBounds

An axis index exceeded the array’s dimensionality.

Fields

axis: usize

The invalid axis.

ndim: usize

Number of dimensions.

IndexOutOfBounds

An element index exceeded the array’s extent along some axis.

Fields

index: isize

The invalid index.

axis: usize

The axis along which the index was applied.

size: usize

The size of that axis.

SingularMatrix

A matrix was singular when an invertible one was required.

Fields

message: String

Diagnostic context.

ConvergenceFailure

An iterative algorithm did not converge within its budget.

Fields

iterations: usize

Number of iterations attempted.

message: String

Diagnostic context.

InvalidDtype

The requested dtype is invalid or unsupported for this operation.

Fields

message: String

Diagnostic context.

NumericalInstability

A computation produced NaN / Inf when finite results were required.

Fields

message: String

Diagnostic context.

IoError

An I/O operation failed.

Fields

message: String

Diagnostic context.

InvalidValue

A function argument was invalid.

Fields

message: String

Diagnostic context.

Implementations

impl FerrayError

pub fn shape_mismatch(msg: impl Display) -> Self

Create a ShapeMismatch error with a formatted message.

pub fn broadcast_failure(a: &[usize], b: &[usize]) -> Self

Create a BroadcastFailure error.

pub fn axis_out_of_bounds(axis: usize, ndim: usize) -> Self

Create an AxisOutOfBounds error.

pub fn index_out_of_bounds(index: isize, axis: usize, size: usize) -> Self

Create an IndexOutOfBounds error.

pub fn invalid_dtype(msg: impl Display) -> Self

Create an InvalidDtype error with a formatted message.

pub fn invalid_value(msg: impl Display) -> Self

Create an InvalidValue error with a formatted message.

pub fn io_error(msg: impl Display) -> Self

Create an IoError from a formatted message.

Trait Implementations

impl Clone for FerrayError

fn clone(&self) -> FerrayError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FerrayError

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

Formats the value using the given formatter.

impl Display for FerrayError

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

Formats the value using the given formatter.

impl Error for FerrayError

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 FerrayError

Available on non-crate feature no_std only.

fn from(e: Error) -> Self

Converts to this type from the input type.