gam 0.3.115

Generalized penalized likelihood engine
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Typed errors emitted by smooth-term helpers.
//!
//! Carved out of the `smooth` module along its first real seam: this is the
//! error vocabulary every smooth-term builder shares, with no dependency on the
//! basis/penalty/optimizer machinery that surrounds it. `Display` reproduces the
//! exact pre-refactor `format!(...)` text byte-for-byte, so string-matching
//! callers (tests, log assertions) keep working unchanged. Public boundaries
//! that interface with `term_builder.rs` / `construction` continue to return
//! `Result<_, String>`; typed `Err(...)` values flow through
//! `From<SmoothError> for String` at those boundaries via `.into()`.

use crate::util::block_count::BlockCountMismatch;

/// Typed errors emitted by smooth-term helpers in the `smooth` module.
#[derive(Clone, Debug)]
pub enum SmoothError {
    /// Spec-level configuration error: unfrozen knots/centers, invalid
    /// numeric bounds on coefficient priors, length-scale optimizer options
    /// that violate `min > 0 < max` / `min < max` invariants, etc.
    InvalidConfig { reason: String },
    /// Shape / length disagreement between design columns, penalty blocks,
    /// coefficient ranges, directional-derivative vectors, theta length, and
    /// other bookkeeping invariants that are checked at runtime.
    DimensionMismatch { reason: String },
    /// Out-of-range index into adaptive hyperparameter components, psi
    /// derivative blocks, or non-zero block indices for single-block
    /// custom-family impls that only support `block_idx == 0`.
    InvalidIndex { reason: String },
}

impl std::fmt::Display for SmoothError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SmoothError::InvalidConfig { reason }
            | SmoothError::DimensionMismatch { reason }
            | SmoothError::InvalidIndex { reason } => f.write_str(reason),
        }
    }
}

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

impl From<SmoothError> for String {
    fn from(err: SmoothError) -> String {
        err.to_string()
    }
}

impl From<BlockCountMismatch> for SmoothError {
    fn from(err: BlockCountMismatch) -> SmoothError {
        SmoothError::invalid_index(err.message())
    }
}

impl SmoothError {
    #[inline]
    pub(super) fn invalid_config(reason: impl Into<String>) -> Self {
        SmoothError::InvalidConfig {
            reason: reason.into(),
        }
    }
    #[inline]
    pub(super) fn dimension_mismatch(reason: impl Into<String>) -> Self {
        SmoothError::DimensionMismatch {
            reason: reason.into(),
        }
    }
    #[inline]
    pub(super) fn invalid_index(reason: impl Into<String>) -> Self {
        SmoothError::InvalidIndex {
            reason: reason.into(),
        }
    }
}