Enum LinearDictionaryError 

pub enum LinearDictionaryError {
    InvalidInput {
        reason: String,
    },
    NumericalFailure {
        reason: String,
    },
    NonConvergence {
        iterations: usize,
        explained_variance: f64,
        ev_residual: f64,
        routing_residual: f64,
        accepted_births: usize,
        tolerance: f64,
    },
}

Typed failure from fit_linear_dictionary.

In particular, LinearDictionaryError::NonConvergence preserves the numerical certificate that prevented the final iterate from becoming a LinearDictionaryFit.

Variants

InvalidInput

Fields

reason: String

NumericalFailure

Fields

reason: String

NonConvergence

Fields

iterations: usize

explained_variance: f64

ev_residual: f64

routing_residual: f64

accepted_births: usize

tolerance: f64

Trait Implementations

impl Clone for LinearDictionaryError

fn clone(&self) -> LinearDictionaryError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinearDictionaryError

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

Formats the value using the given formatter.

impl Display for LinearDictionaryError

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

Formats the value using the given formatter.

impl Error for LinearDictionaryError

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<String> for LinearDictionaryError

fn from(reason: String) -> Self

Converts to this type from the input type.

impl PartialEq for LinearDictionaryError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LinearDictionaryError