Skip to main content

gamlss_spline/
error.rs

1use gamlss_core::ModelError;
2use thiserror::Error;
3
4/// Errors for spline basis and spline design matrix construction.
5#[derive(Debug, Clone, PartialEq, Eq, Error)]
6pub enum SplineError {
7    /// Input vector is empty.
8    #[error("spline input must contain at least one value")]
9    EmptyInput,
10
11    /// Input vector contains `NaN` or infinity.
12    #[error("spline input contains a non-finite value")]
13    NonFiniteValue,
14
15    /// Data range does not have two distinct finite boundaries and a finite span.
16    #[error("spline range must have distinct finite boundaries and a finite span")]
17    InvalidRange,
18
19    /// Number of basis functions is insufficient for the spline degree.
20    #[error("B-spline basis count {n_basis} must be greater than degree {degree}")]
21    NotEnoughBasis {
22        /// Requested number of basis functions.
23        n_basis: usize,
24        /// B-spline degree.
25        degree: usize,
26    },
27
28    /// Knot vector contains non-finite values or is decreasing.
29    #[error("knot vector must be finite and nondecreasing")]
30    InvalidKnots,
31
32    /// Knot vector does not contain enough knots.
33    #[error("spline knot vector must contain at least {min} knots")]
34    NotEnoughKnots {
35        /// Minimum number of knots.
36        min: usize,
37    },
38
39    /// Period must be a finite positive number.
40    #[error("spline period must be finite and positive")]
41    InvalidPeriod,
42
43    /// Predictor blocks have different row counts.
44    #[error("spline row count mismatch: expected {expected}, got {actual}")]
45    RowMismatch {
46        /// Expected row count.
47        expected: usize,
48        /// Actual row count.
49        actual: usize,
50    },
51
52    /// Parameter count overflowed `usize`.
53    #[error("spline parameter count overflowed")]
54    ParameterOverflow,
55
56    /// The spline degree is not supported by this compact predictor.
57    #[error("spline degree {degree} is not supported")]
58    UnsupportedDegree {
59        /// Requested degree.
60        degree: usize,
61    },
62
63    /// Core design matrix error.
64    #[error(transparent)]
65    Model(#[from] ModelError),
66}
67
68/// Errors for Fourier basis and Fourier predictor construction.
69#[derive(Debug, Clone, PartialEq, Eq, Error)]
70pub enum FourierError {
71    /// Input vector contains `NaN` or infinity.
72    #[error("Fourier input contains a non-finite value")]
73    NonFiniteValue,
74
75    /// Period must be positive and both it and its angular frequency must be finite.
76    #[error("Fourier period must be positive with finite period and angular frequency")]
77    InvalidPeriod,
78
79    /// Number of harmonics must be positive.
80    #[error("Fourier order must be greater than zero")]
81    InvalidOrder,
82
83    /// Coefficient count overflowed `usize`.
84    #[error("Fourier coefficient count overflowed")]
85    CoefficientOverflow,
86}