Enum CalibrationError 

pub enum CalibrationError {
    TooFewQuotes {
        got: usize,
        need: usize,
    },
    EmptyQuotes,
    DidNotConverge {
        iterations: usize,
        residual: f64,
    },
    AllWeightsZero,
    Param(ParamError),
}

Error returned when a calibrator cannot produce a usable fit.

Covers insufficient data, non-convergence of the outer optimiser, and any parameter error surfaced while assembling the calibrated slice.

Examples

use regit_svi::errors::CalibrationError;

let err = CalibrationError::TooFewQuotes { got: 2, need: 5 };
let msg = format!("{err}");
assert!(msg.contains("2"));
assert!(msg.contains("5"));

Variants

TooFewQuotes

Fewer quotes were supplied than the model has free parameters.

Fields

got: usize

Number of quotes supplied.

need: usize

Minimum number of quotes required.

EmptyQuotes

The supplied quote set is empty.

DidNotConverge

The outer optimiser reached its iteration cap without converging.

Fields

iterations: usize

Number of iterations performed.

residual: f64

The final residual norm.

AllWeightsZero

All fitting weights are zero, so the objective is identically zero.

Param(ParamError)

A parameter error surfaced while assembling the calibrated slice.

Trait Implementations

impl Clone for CalibrationError

fn clone(&self) -> CalibrationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalibrationError

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

Formats the value using the given formatter.

impl Display for CalibrationError

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

Formats the value using the given formatter.

impl Error for CalibrationError

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<ParamError> for CalibrationError

fn from(e: ParamError) -> Self

Converts to this type from the input type.

impl PartialEq for CalibrationError

fn eq(&self, other: &CalibrationError) -> 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 Copy for CalibrationError

impl StructuralPartialEq for CalibrationError