Enum SingularityReason 

#[non_exhaustive]
pub enum SingularityReason {
    Exact,
    #[non_exhaustive]
    Numerical {
        factorization: FactorizationKind,
        pivot_magnitude: f64,
        tolerance: f64,
    },
}

Mathematical or numerical reason a matrix was classified as singular.

Examples

use la_stack::prelude::*;

match LaError::singular_numerical(1, FactorizationKind::Lu, 0.0, 1e-12) {
    LaError::Singular {
        reason: SingularityReason::Numerical { factorization, .. }, ..
    } => assert_eq!(factorization, FactorizationKind::Lu),
    _ => unreachable!("constructor preserves the singularity reason"),
}

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.

Exact

The algorithm proved that the pivot is exactly zero.

#[non_exhaustive]

Numerical

A finite pivot was rejected by the factorization tolerance.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

factorization: FactorizationKind

Factorization applying the tolerance policy.

pivot_magnitude: f64

Absolute magnitude of the rejected pivot.

tolerance: f64

Tolerance against which the magnitude was compared.

Trait Implementations

impl Clone for SingularityReason

fn clone(&self) -> SingularityReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SingularityReason

impl Debug for SingularityReason

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

Formats the value using the given formatter.

impl PartialEq for SingularityReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SingularityReason