Enum Error 

pub enum Error {
    InvalidInput(String),
    Derivative(DerivativeError),
    SpecialFunction(String),
    NonFinite(String),
    NotConverged(String),
    Singular,
    OutOfMemory(String),
}

A numerical failure, invalid physical input or refused memory.

The Python bindings raise OutOfMemory as MemoryError and every other variant as ValueError, each with the displayed message.

Variants

InvalidInput(String)

The operation does not accept the input, for example a negative degree or a non-finite wavenumber.

Derivative(DerivativeError)

A derivative is unavailable at the supplied inputs or weights.

SpecialFunction(String)

An AMOS Bessel, Legendre, Ferrers, Wigner, incomplete gamma or Kambe evaluation failed.

NonFinite(String)

A finite input produced a non-finite value, for example an overflowing phase.

NotConverged(String)

A sum, series, iteration or decomposition did not reach its tolerance, or cancellation lost the accuracy.

Singular

A linear system (an LU solve, a 2 x 2 Mie inverse or an S-matrix solve) is singular at the supplied parameters.

OutOfMemory(String)

The system refused memory for an output or workspace. The bindings raise it as MemoryError.

Implementations

impl Error

pub fn out_of_memory(count: usize, element_bytes: usize) -> Self

OutOfMemory for count elements of element_bytes bytes each: “cannot allocate 4096 bytes”, or “cannot allocate more than 18446744073709551615 bytes” (usize::MAX on 64-bit targets) when the product overflows.

pub(crate) const fn is_numerical(&self) -> bool

Whether the evaluation failed numerically (SpecialFunction, NonFinite or NotConverged) rather than on its input, a singular system or memory.

Another method may succeed where one fails numerically: the one-dimensional spherical lattice sums then fall back to their spectral series.

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.