nereids-fitting 0.1.2

Optimization engine for resonance fitting (LM, Poisson/BFGS)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Error types for the nereids-fitting crate.

use std::fmt;

/// Errors from fitting operations (input validation).
#[derive(Debug)]
pub enum FittingError {
    /// Observed data is empty.
    EmptyData,
    /// Array length mismatch.
    LengthMismatch {
        /// Expected length.
        expected: usize,
        /// Actual length.
        actual: usize,
        /// Name of the mismatched field.
        field: &'static str,
    },
    /// Invalid model configuration.
    InvalidConfig(String),
    /// Model evaluation failed (e.g. broadening error, invalid physics state).
    EvaluationFailed(String),
}

impl fmt::Display for FittingError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::EmptyData => write!(f, "observed data must not be empty"),
            Self::LengthMismatch {
                expected,
                actual,
                field,
            } => write!(
                f,
                "{field} length ({actual}) must match expected length ({expected})"
            ),
            Self::InvalidConfig(msg) => write!(f, "invalid model configuration: {msg}"),
            Self::EvaluationFailed(msg) => write!(f, "model evaluation failed: {msg}"),
        }
    }
}

impl std::error::Error for FittingError {}