Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidParameter {
        name: &'static str,
        value: String,
        reason: String,
    },
    OutOfDomain {
        name: &'static str,
        value: f64,
        domain: (f64, f64),
    },
    InvalidMatsubaraIndex {
        n: i64,
        statistics: Statistics,
    },
    EmptyInput {
        name: &'static str,
    },
    NonFiniteInput {
        name: &'static str,
        index: Vec<usize>,
        value: f64,
    },
    KernelStatisticsMismatch,
    InsufficientDefaultPoles {
        basis_size: usize,
        n_poles: usize,
    },
    AxisOutOfRange {
        axis: usize,
        rank: usize,
    },
    ShapeMismatch {
        which: ArrayRole,
        expected: Vec<usize>,
        actual: Vec<usize>,
    },
    NotSupported {
        what: String,
    },
    DecompositionFailed {
        reason: String,
    },
    Gemm(GemmError),
    Tensor {
        reason: String,
    },
}

Error returned by the fallible public functions of this crate

More variants may be added without a major version bump. To handle a category of errors rather than one variant, match on Error::kind.

Errors compare equal when all their fields do. An error that holds a NaN value is therefore not equal to itself; match on the variant instead.

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.

InvalidParameter

A parameter is outside its valid range.

Fields

name: &'static str

Name of the parameter, as in the documentation of the function

value: String

The rejected value, formatted for the message

reason: String

The condition that the value violates, e.g. “must be in (0, 1)”

OutOfDomain

A point lies outside the domain of a function, e.g. τ outside [-β, β] or x outside the knots of a polynomial. NaN lies outside every domain.

Fields

name: &'static str

Name of the argument, as in the documentation of the function

value: f64

The rejected point

domain: (f64, f64)

The closed interval (lower, upper) of valid points

InvalidMatsubaraIndex

A Matsubara frequency index is not allowed: n must be odd for fermionic and even for bosonic statistics, and non-negative for a positive-only sampling. The message says which: a wrong parity, or a negative n of the right parity.

Fields

n: i64

The rejected index

statistics: Statistics

The statistics that n was checked against

EmptyInput

An input that must not be empty is empty.

Fields

name: &'static str

Name of the input, as in the documentation of the function

NonFiniteInput

An input contains NaN or an infinity.

Fields

name: &'static str

Name of the input, as in the documentation of the function

index: Vec<usize>

Index of the first non-finite entry ([row, column] for a matrix)

value: f64

That entry, converted to f64

KernelStatisticsMismatch

The kernel does not support the requested statistics, e.g. RegularizedBoseKernel with fermionic statistics.

InsufficientDefaultPoles

The basis has fewer default poles than functions, so its default poles cannot define a DLR. This can happen with certain kernels (e.g. RegularizedBoseKernel) because of the limited precision of the root finding.

Fields

basis_size: usize

Basis size

n_poles: usize

Number of default poles found

AxisOutOfRange

An axis argument is not an axis of the array, e.g. dim of evaluate_nd for an array of rank dim or less.

Fields

axis: usize

The rejected axis

rank: usize

The rank of the array

ShapeMismatch

An array has the wrong shape. For a slice, the shapes have one entry, its length.

Fields

which: ArrayRole

Which array: an input, or the output

expected: Vec<usize>

The shape the operation needs

actual: Vec<usize>

The shape of the array

NotSupported

The operation is not defined for this input, e.g. default Matsubara sampling points for basis functions without a definite parity (#183).

Fields

what: String

What is not supported, and why

DecompositionFailed

A matrix decomposition failed, e.g. the SVD iteration did not converge.

Fields

reason: String

What failed, with the values involved

Gemm(GemmError)

The GEMM backend rejected a call, e.g. a dimension exceeds the integer range of an injected BLAS.

Tensor

A tenferro tensor operation failed.

Fields

reason: String

The message of the tenferro error

Implementations

impl Error

pub fn kind(&self) -> ErrorKind

Category of the error

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<GemmError> for Error

fn from(source: GemmError) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error