Enum EstimationError 

pub enum EstimationError {
    BasisError(BasisError),
    CustomFamily(CustomFamilyError),
    LinearSystemSolveFailed(FaerLinalgError),
    EigendecompositionFailed(FaerLinalgError),
    PenaltySpectrumNonFinite {
        context: String,
        index: usize,
        value: f64,
    },
    PenaltySpectrumIndefinite {
        context: String,
        index: usize,
        value: f64,
        tolerance: f64,
        scale: f64,
    },
    ParameterConstraintViolation(String),
    PirlsDidNotConverge {
        max_iterations: usize,
        last_change: f64,
    },
    PerfectSeparationDetected {
        iteration: usize,
        max_abs_eta: f64,
    },
    PrefitPerfectSeparationDetected {
        column_index: usize,
        threshold: f64,
        positive_above_threshold: bool,
    },
    PrefitLinearSeparationDetected {
        min_signed_margin: f64,
        num_unpenalized_columns: usize,
        column_indices: Vec<usize>,
    },
    PrefitRankDeficientDesignDetected {
        rank: usize,
        num_unpenalized_columns: usize,
        min_eigenvalue: f64,
        tolerance: f64,
        column_indices: Vec<usize>,
    },
    PrefitNearDegenerateDesignDetected {
        num_unpenalized_columns: usize,
        condition_number: f64,
        min_eigenvalue: f64,
        max_eigenvalue: f64,
        tolerance: f64,
        column_indices: Vec<usize>,
    },
    MultinomialSeparationDetected {
        iteration: usize,
        max_abs_eta: f64,
        active_class_index: usize,
        row_index: usize,
    },
    HessianNotPositiveDefinite {
        min_eigenvalue: f64,
    },
    RemlOptimizationFailed(String),
    GradientUnavailable {
        context: &'static str,
        mode: &'static str,
    },
    LayoutError(String),
    ModelOverparameterized {
        num_coeffs: usize,
        num_samples: usize,
        intercept_coeffs: usize,
        binary_main_coeffs: usize,
        primary_smooth_coeffs: usize,
        aux_main_coeffs: usize,
        binary_primary_interaction_coeffs: usize,
        aux_interaction_coeffs: usize,
    },
    ModelIsIllConditioned {
        condition_number: f64,
    },
    InvalidInput(String),
    MonotoneRoot(MonotoneRootError),
    CalibratorTrainingFailed(String),
    InvalidSpecification(String),
    PredictionError,
}

A comprehensive error type for the model estimation process.

Variants

BasisError(BasisError)

CustomFamily(CustomFamilyError)

LinearSystemSolveFailed(FaerLinalgError)

EigendecompositionFailed(FaerLinalgError)

PenaltySpectrumNonFinite

Fields

context: String

index: usize

value: f64

PenaltySpectrumIndefinite

Fields

context: String

index: usize

value: f64

tolerance: f64

scale: f64

ParameterConstraintViolation(String)

PirlsDidNotConverge

Fields

max_iterations: usize

last_change: f64

PerfectSeparationDetected

Fields

iteration: usize

max_abs_eta: f64

PrefitPerfectSeparationDetected

Fields

column_index: usize

threshold: f64

positive_above_threshold: bool

PrefitLinearSeparationDetected

Fields

min_signed_margin: f64

num_unpenalized_columns: usize

column_indices: Vec<usize>

PrefitRankDeficientDesignDetected

Fields

rank: usize

num_unpenalized_columns: usize

min_eigenvalue: f64

tolerance: f64

column_indices: Vec<usize>

PrefitNearDegenerateDesignDetected

Fields

num_unpenalized_columns: usize

condition_number: f64

min_eigenvalue: f64

max_eigenvalue: f64

tolerance: f64

column_indices: Vec<usize>

MultinomialSeparationDetected

Fields

iteration: usize

max_abs_eta: f64

active_class_index: usize

row_index: usize

HessianNotPositiveDefinite

Fields

min_eigenvalue: f64

RemlOptimizationFailed(String)

GradientUnavailable

Fields

context: &'static str

mode: &'static str

LayoutError(String)

ModelOverparameterized

Fields

num_coeffs: usize

num_samples: usize

intercept_coeffs: usize

binary_main_coeffs: usize

primary_smooth_coeffs: usize

aux_main_coeffs: usize

binary_primary_interaction_coeffs: usize

aux_interaction_coeffs: usize

ModelIsIllConditioned

Fields

condition_number: f64

InvalidInput(String)

MonotoneRoot(MonotoneRootError)

CalibratorTrainingFailed(String)

InvalidSpecification(String)

PredictionError

Implementations

impl EstimationError

pub fn is_inner_solve_retreat(&self) -> bool

Classifies inner-solve failures that the outer REML loop should treat as a soft retreat (return +inf cost / infeasible outer-eval) rather than propagate as a hard error.

Why: when the penalised Hessian becomes effectively singular at the current rho, when P-IRLS hits a perfect-separation diagnostic, or when it exhausts its iteration budget, the outer optimiser’s correct response is to back away from this rho — not to terminate the fit. All three variants encode “the inner problem at this rho is too hard to evaluate, try a different rho”.

Trait Implementations

impl Debug for EstimationError

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

Formats the value using the given formatter.

impl Display for EstimationError

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

Formats the value using the given formatter.

impl Error for EstimationError

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<BasisError> for EstimationError

fn from(source: BasisError) -> Self

Converts to this type from the input type.

impl From<CustomFamilyError> for EstimationError

fn from(source: CustomFamilyError) -> Self

Converts to this type from the input type.

impl From<LinalgError> for EstimationError

fn from(error: LinalgError) -> Self

Converts to this type from the input type.

impl From<MonotoneRootError> for EstimationError

fn from(source: MonotoneRootError) -> Self

Converts to this type from the input type.