gamlss-spline 0.2.1

Spline bases, penalties, and metadata for GAMLSS modeling
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use gamlss_core::PredictorBlock;

use crate::cyclic::{CyclicSplineDesign, CyclicSplineSpec};
use crate::row_basis::SplineRowBasis;
use crate::{SplineError, SplineOrder};

/// Metadata for a cyclic spline over a physical period.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct PeriodicSplineSpec {
    cyclic: CyclicSplineSpec,
    period: f64,
    origin: f64,
}

impl PeriodicSplineSpec {
    /// Creates a periodic spline spec.
    pub fn new(
        n_basis: usize,
        order: SplineOrder,
        period: f64,
        origin: f64,
    ) -> Result<Self, SplineError> {
        if !period.is_finite() || period <= 0.0 || !origin.is_finite() {
            return Err(SplineError::InvalidPeriod);
        }
        Ok(Self {
            cyclic: CyclicSplineSpec::new(n_basis, order)?,
            period,
            origin,
        })
    }

    /// Builds a design for physical coordinates.
    pub fn design(&self, x: &[f64]) -> Result<PeriodicSplineDesign, SplineError> {
        if x.iter().any(|value| !value.is_finite()) {
            return Err(SplineError::NonFiniteValue);
        }
        let phi = x
            .iter()
            .map(|value| (value - self.origin) / self.period)
            .collect::<Vec<_>>();
        Ok(PeriodicSplineDesign {
            x: x.to_vec(),
            phase_design: self.cyclic.design(&phi)?,
            spec: *self,
        })
    }

    /// Number of spline coefficients.
    #[must_use]
    #[inline(always)]
    pub fn n_basis(&self) -> usize {
        self.cyclic.n_basis()
    }

    /// Period.
    #[must_use]
    #[inline(always)]
    pub fn period(&self) -> f64 {
        self.period
    }

    /// Origin.
    #[must_use]
    #[inline(always)]
    pub fn origin(&self) -> f64 {
        self.origin
    }
}

/// Periodic spline predictor over physical coordinates.
#[derive(Debug, Clone, PartialEq)]
pub struct PeriodicSplineDesign {
    x: Vec<f64>,
    phase_design: CyclicSplineDesign,
    spec: PeriodicSplineSpec,
}

impl PeriodicSplineDesign {
    /// Creates a periodic spline design.
    pub fn new(
        x: &[f64],
        n_basis: usize,
        order: SplineOrder,
        period: f64,
        origin: f64,
    ) -> Result<Self, SplineError> {
        PeriodicSplineSpec::new(n_basis, order, period, origin)?.design(x)
    }

    /// Input coordinates.
    #[must_use]
    #[inline(always)]
    pub fn x(&self) -> &[f64] {
        &self.x
    }

    /// Number of spline coefficients.
    #[must_use]
    #[inline(always)]
    pub fn n_basis(&self) -> usize {
        self.spec.n_basis()
    }

    /// Metadata.
    #[must_use]
    #[inline(always)]
    pub fn spec(&self) -> PeriodicSplineSpec {
        self.spec
    }

    /// Predictor derivative with respect to the original coordinate.
    #[must_use]
    #[inline]
    pub fn eta_derivative_row(&self, row: usize, beta: &[f64]) -> f64 {
        debug_assert!(row < self.x.len());
        debug_assert_eq!(beta.len(), self.n_basis());

        self.phase_design.eta_derivative_row(row, beta) / self.spec.period
    }
}

impl PredictorBlock for PeriodicSplineDesign {
    #[inline(always)]
    fn nrows(&self) -> usize {
        PredictorBlock::nrows(&self.phase_design)
    }

    #[inline(always)]
    fn nparams(&self) -> usize {
        PredictorBlock::nparams(&self.phase_design)
    }

    #[inline(always)]
    fn eta_row(&self, row: usize, beta: &[f64]) -> f64 {
        self.phase_design.eta_row(row, beta)
    }

    #[inline]
    fn add_gradient(&self, scores: &[f64], beta: &[f64], grad: &mut [f64]) {
        self.phase_design.add_gradient(scores, beta, grad);
    }

    #[inline]
    fn add_weighted_gradient(
        &self,
        scores: &[f64],
        multiplier: &[f64],
        beta: &[f64],
        grad: &mut [f64],
    ) {
        self.phase_design
            .add_weighted_gradient(scores, multiplier, beta, grad);
    }
}

impl SplineRowBasis for PeriodicSplineDesign {
    #[inline(always)]
    fn nrows(&self) -> usize {
        SplineRowBasis::nrows(&self.phase_design)
    }

    #[inline(always)]
    fn nparams(&self) -> usize {
        SplineRowBasis::nparams(&self.phase_design)
    }

    #[inline(always)]
    fn for_each_row_basis(&self, row: usize, f: impl FnMut(usize, f64)) {
        self.phase_design.for_each_row_basis(row, f);
    }
}