Enum IlsError 

pub enum IlsError {
    Singular,
    NoCandidates(usize),
    TooManyCandidates {
        evaluated: usize,
        limit: usize,
    },
    InvalidDimensions {
        n: usize,
        rows: usize,
    },
    NonFinite,
    InvalidInput {
        field: &'static str,
        reason: &'static str,
    },
    SearchLimitExceeded,
}

Why a bounded ILS search could not produce a result. Mapped by the NIF onto the reference Elixir error tuples (:singular_geometry, {:no_integer_candidates, n}, {:too_many_integer_candidates, n, limit}).

Variants

Singular

The covariance matrix is singular (degenerate geometry).

NoCandidates(usize)

The lattice yielded no candidate (an empty search box).

TooManyCandidates

The lattice exceeded candidate_limit.

Fields

evaluated: usize

limit: usize

InvalidDimensions

float_cycles was empty, or covariance was not exactly n x n for n = float_cycles.len() (rows is the offending row count, or the length of the first row that was not n wide).

Fields

n: usize

rows: usize

NonFinite

A float_cycles or covariance entry was NaN or infinite.

InvalidInput

A public ILS option was malformed.

Fields

field: &'static str

reason: &'static str

SearchLimitExceeded

The MLAMBDA search did not converge within LAMBDA_LOOP_MAX iterations (distinct from a singular/degenerate covariance).

Trait Implementations

impl Clone for IlsError

fn clone(&self) -> IlsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IlsError

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

Formats the value using the given formatter.

impl Display for IlsError

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

Formats the value using the given formatter.

impl Eq for IlsError

impl Error for IlsError

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 PartialEq for IlsError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IlsError