Enum Error 

#[non_exhaustive]
pub enum Error {
    NonConvergence {
        op: &'static str,
    },
    Singular {
        op: &'static str,
    },
    UnsupportedDType {
        op: &'static str,
        dtype: DType,
    },
}

Failures owned by a linalg algorithm or provider boundary.

Examples

use tenferro_linalg::Error;
use tenferro_tensor::ErrorKind;

let error = Error::Singular { op: "solve" };
assert_eq!(error.kind(), ErrorKind::NumericalFailure);

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.

NonConvergence

The algorithm could not converge for the supplied numeric input.

Fields

op: &'static str

Linalg operation that failed to converge.

Singular

The input matrix or factorization became singular.

Fields

op: &'static str

Linalg operation that encountered a singular matrix.

UnsupportedDType

The selected linalg operation has no implementation for this dtype.

Fields

op: &'static str

Linalg operation that rejected the dtype.

dtype: DType

Rejected input dtype.

Implementations

impl Error

pub fn kind(&self) -> ErrorKind

Return the stable coarse classification for this linalg failure.

Examples

use tenferro_linalg::Error;
use tenferro_tensor::ErrorKind;

assert_eq!(
    Error::NonConvergence { op: "svd" }.kind(),
    ErrorKind::NumericalFailure
);

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.