fdars-core 0.40.0

Functional Data Analysis algorithms in Rust
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
//! Bayesian function-on-scalar regression via conjugate Gibbs sampler (REG-06-04).
//!
//! Fits `Y_i(t) = μ(t) + Σ_j x̃_ij · β_j(t) + ε_i(t)` where `x̃` are the
//! mean-centered scalar predictors and `β_j(t)` are functional coefficients. The
//! functional dimension is compressed with FPCA (`fdata_to_pc_1d`): the response
//! is projected onto its top-`K` functional principal components, and for each
//! component `k` the FPC scores are regressed on the predictors with a conjugate
//! Normal / Inverse-Gamma Gibbs sampler. Each retained draw reconstructs the
//! coefficient functions `β_j(t) = Σ_k b_{jk} · φ_k(t)` from the FPCA rotation, so
//! posterior summaries (mean + **pointwise** credible bands) are obtained directly
//! in the functional domain.
//!
//! # Full conditionals (per FPC component `k`)
//!
//! Model: `ξ_k = X̃ · b_k + ε_k`, `ξ_k ∈ Rⁿ` (scores of component k), `X̃ ∈ R^{n×p}`.
//! Priors: `b_k | σ²_k ~ N(0, τ²·I_p)`, `σ²_k ~ IG(a₀, b₀)`.
//!
//! - `b_k | · ~ N(μ_post, A⁻¹)` with precision `A = X̃'X̃/σ²_k + I_p/τ²`,
//!   `μ_post = A⁻¹ · X̃'ξ_k / σ²_k`. Sampled via Cholesky `A = LLᵀ`:
//!   `b_k = μ_post + Lᵀ⁻¹ z`, `z ~ N(0, I_p)` (Rue 2001) — `Cov = (LLᵀ)⁻¹ = A⁻¹`.
//! - `σ²_k | · ~ IG(a₀ + n/2, b₀ + RSS_k/2)`, drawn as `1 / Gamma(α, 1/β)`.
//!
//! The chain is fully deterministic given `config.seed`
//! (`StdRng::seed_from_u64(seed)`).
//!
//! # References
//!
//! Rue (2001). Fast sampling of Gaussian Markov random fields. *JRSS-B* 63(2).
//! Goldsmith et al. (2015). *JCGS* 23(1). Jiang et al. (2025), arXiv:2505.05633.
//!
//! # Divergences from refund
//!
//! `refund`'s Bayesian FOSR uses spline basis priors with random effects; this
//! implementation uses FPCA score compression (`fdata_to_pc_1d`) for simplicity and
//! zero new dependencies. Pointwise credible bands only (no simultaneous bands).

use super::{BayesianConfig, BayesianFosrResult};
use crate::error::FdarError;
use crate::linalg::{cholesky_factor, cholesky_forward_back, compute_xtx};
use crate::matrix::FdMatrix;
use crate::regression::fdata_to_pc_1d;
use rand::rngs::StdRng;
use rand::{Rng, SeedableRng};
use rand_distr::{Distribution, Gamma, StandardNormal};

/// Solve `Lᵀ v = z` (back substitution) for a lower-triangular `L` stored flat
/// row-major (`L[i*p + j]`, `i ≥ j`). Used to draw `N(0, (LLᵀ)⁻¹)` as `Lᵀ⁻¹ z`.
fn back_solve_lt(l: &[f64], z: &[f64], p: usize) -> Vec<f64> {
    let mut v = z.to_vec();
    for j in (0..p).rev() {
        for k in (j + 1)..p {
            // (Lᵀ)_{jk} = L_{kj} = l[k*p + j]
            v[j] -= l[k * p + j] * v[k];
        }
        v[j] /= l[j * p + j];
    }
    v
}

/// Linear-interpolated quantile of an already-sorted slice.
fn quantile_sorted(sorted: &[f64], q: f64) -> f64 {
    let n = sorted.len();
    if n == 0 {
        return f64::NAN;
    }
    if n == 1 {
        return sorted[0];
    }
    let pos = q * (n as f64 - 1.0);
    let lo = pos.floor() as usize;
    let hi = pos.ceil() as usize;
    let frac = pos - lo as f64;
    sorted[lo] * (1.0 - frac) + sorted[hi] * frac
}

/// Bayesian function-on-scalar regression via conjugate Gibbs sampler.
///
/// Compresses the functional response with FPCA, runs a conjugate Normal /
/// Inverse-Gamma Gibbs sampler on the FPC-score regression coefficients, and
/// reconstructs posterior summaries of the coefficient functions `β_j(t)`.
///
/// # Arguments
///
/// * `data` — Functional response Y (n × m_t, column-major).
/// * `predictors` — Scalar predictor matrix X (n × p). Centered internally.
/// * `argvals` — Response grid evaluation points (length m_t).
/// * `config` — [`BayesianConfig`] (FPC components, priors, iterations, seed).
///
/// # Returns
///
/// [`BayesianFosrResult`] with posterior-mean coefficient functions `beta_mean`
/// (p × m_t), pointwise 2.5% / 97.5% credible bands, posterior-mean fitted values
/// and residuals, and the posterior-mean residual variance `sigma2_mean(t)`.
///
/// # Errors
///
/// [`FdarError::InvalidDimension`] on shape mismatch; [`FdarError::InvalidParameter`]
/// on out-of-range config; [`FdarError::ComputationFailed`] if FPCA or a Cholesky
/// draw fails.
#[must_use = "expensive computation whose result should not be discarded"]
pub fn bayesian_fosr(
    data: &FdMatrix,
    predictors: &FdMatrix,
    argvals: &[f64],
    config: &BayesianConfig,
) -> Result<BayesianFosrResult, FdarError> {
    let (n, m_t) = data.shape();
    let p = predictors.ncols();

    // ---- Validation --------------------------------------------------------
    if n < 2 || m_t == 0 || predictors.nrows() != n {
        return Err(FdarError::InvalidDimension {
            parameter: "data/predictors",
            expected: format!("n >= 2, m_t > 0, predictors.nrows() == n (n={n})"),
            actual: format!(
                "n={n}, m_t={m_t}, predictors.nrows()={}",
                predictors.nrows()
            ),
        });
    }
    if argvals.len() != m_t {
        return Err(FdarError::InvalidDimension {
            parameter: "argvals",
            expected: format!("length == data.ncols() = {m_t}"),
            actual: format!("length = {}", argvals.len()),
        });
    }
    if p == 0 {
        return Err(FdarError::InvalidDimension {
            parameter: "predictors",
            expected: "at least 1 predictor column".to_string(),
            actual: "0 columns".to_string(),
        });
    }
    if config.ncomp == 0 {
        return Err(FdarError::InvalidParameter {
            parameter: "ncomp",
            message: "must be >= 1".to_string(),
        });
    }
    if config.tau2 <= 0.0 {
        return Err(FdarError::InvalidParameter {
            parameter: "tau2",
            message: format!("must be > 0, got {}", config.tau2),
        });
    }
    if config.ig_a0 <= 0.0 || config.ig_b0 <= 0.0 {
        return Err(FdarError::InvalidParameter {
            parameter: "ig_a0/ig_b0",
            message: format!("must be > 0, got a0={}, b0={}", config.ig_a0, config.ig_b0),
        });
    }
    if config.n_iter == 0 {
        return Err(FdarError::InvalidParameter {
            parameter: "n_iter",
            message: "must be >= 1".to_string(),
        });
    }
    if config.thin == 0 {
        return Err(FdarError::InvalidParameter {
            parameter: "thin",
            message: "must be >= 1".to_string(),
        });
    }

    // ---- FPCA score compression of the response ----------------------------
    let fpca = fdata_to_pc_1d(data, config.ncomp, argvals)?;
    let k = fpca.scores.ncols(); // actual components retained (≤ ncomp)
                                 // rotation: m_t × k loadings φ_k(t); scores: n × k ; mean: m_t response mean.

    // ---- Center predictors -------------------------------------------------
    // β_j(t) is the slope of the centered predictor; the response intercept μ(t)
    // is carried by the FPCA mean function.
    let mut xbar = vec![0.0f64; p];
    for j in 0..p {
        let col = predictors.column(j);
        xbar[j] = col.iter().sum::<f64>() / n as f64;
    }
    // Centered design X̃ (n × p, column-major).
    let mut xc = FdMatrix::zeros(n, p);
    for j in 0..p {
        let src = predictors.column(j);
        let dst = xc.column_mut(j);
        for i in 0..n {
            dst[i] = src[i] - xbar[j];
        }
    }

    // Precompute X̃'X̃ (p × p, row-major) and X̃'ξ_k (p-vector per component).
    let xtx = compute_xtx(&xc); // p × p row-major
    let mut xt_xi: Vec<Vec<f64>> = vec![vec![0.0f64; p]; k]; // [k][j] = Σ_i x̃_ij ξ_ik
    for kk in 0..k {
        let score_col = fpca.scores.column(kk);
        for j in 0..p {
            let xj = xc.column(j);
            let mut s = 0.0f64;
            for i in 0..n {
                s += xj[i] * score_col[i];
            }
            xt_xi[kk][j] = s;
        }
    }

    // Gibbs state: b[k] ∈ R^p (init 0), sigma2[k] (init 1.0).
    let mut b_state: Vec<Vec<f64>> = vec![vec![0.0f64; p]; k];
    let mut sigma2: Vec<f64> = vec![1.0f64; k];

    let inv_tau2 = 1.0 / config.tau2;
    let a_post_shape = config.ig_a0 + n as f64 / 2.0;

    let mut rng = StdRng::seed_from_u64(config.seed);

    let total = config.burn_in + config.n_iter * config.thin;
    let q_retained = config.n_iter; // number of retained draws

    // Per-(j,t) storage of reconstructed β draws for pointwise quantiles.
    let mut beta_draws: Vec<Vec<f64>> = vec![Vec::with_capacity(q_retained); p * m_t];
    // Accumulator for posterior means.
    let mut beta_sum = vec![0.0f64; p * m_t];

    for iter in 0..total {
        for kk in 0..k {
            let s2 = sigma2[kk];
            // Precision A = X̃'X̃ / σ²_k + I_p / τ²  (row-major p×p).
            let mut a = vec![0.0f64; p * p];
            for idx in 0..p * p {
                a[idx] = xtx[idx] / s2;
            }
            for d in 0..p {
                a[d * p + d] += inv_tau2;
            }
            let l = cholesky_factor(&a, p)?;
            // μ_post = A⁻¹ (X̃'ξ_k / σ²_k)
            let mut rhs = vec![0.0f64; p];
            for j in 0..p {
                rhs[j] = xt_xi[kk][j] / s2;
            }
            let mu_post = cholesky_forward_back(&l, &rhs, p);
            // Draw z ~ N(0, I_p) and v = Lᵀ⁻¹ z, then b_k = μ_post + v.
            let z: Vec<f64> = (0..p)
                .map(|_| rng.sample::<f64, _>(StandardNormal))
                .collect();
            let v = back_solve_lt(&l, &z, p);
            for j in 0..p {
                b_state[kk][j] = mu_post[j] + v[j];
            }
            // RSS_k = ||ξ_k - X̃ b_k||²
            let score_col = fpca.scores.column(kk);
            let mut rss = 0.0f64;
            for i in 0..n {
                let mut fit = 0.0f64;
                for j in 0..p {
                    fit += xc.column(j)[i] * b_state[kk][j];
                }
                let r = score_col[i] - fit;
                rss += r * r;
            }
            // σ²_k ~ IG(a_post, b0 + RSS/2)  drawn as 1 / Gamma(shape, scale = 1/rate)
            let rate = config.ig_b0 + rss / 2.0;
            let gamma =
                Gamma::new(a_post_shape, 1.0 / rate).map_err(|e| FdarError::ComputationFailed {
                    operation: "bayesian_fosr Inverse-Gamma draw",
                    detail: format!("Gamma::new failed (shape={a_post_shape}, rate={rate}): {e}"),
                })?;
            let g = gamma.sample(&mut rng);
            sigma2[kk] = 1.0 / g.max(f64::MIN_POSITIVE);
        }

        // Retain thinned post-burn-in draws.
        if iter >= config.burn_in && (iter - config.burn_in) % config.thin == 0 {
            // Reconstruct β_j(t) = Σ_k b_{kj} · φ_k(t) and record.
            for j in 0..p {
                for t in 0..m_t {
                    let mut beta = 0.0f64;
                    for kk in 0..k {
                        beta += b_state[kk][j] * fpca.rotation[(t, kk)];
                    }
                    beta_draws[j * m_t + t].push(beta);
                    beta_sum[j * m_t + t] += beta;
                }
            }
        }
    }

    let q = beta_draws[0].len().max(1);

    // ---- Posterior summaries ----------------------------------------------
    let mut beta_mean = FdMatrix::zeros(p, m_t);
    let mut beta_lower = FdMatrix::zeros(p, m_t);
    let mut beta_upper = FdMatrix::zeros(p, m_t);
    for j in 0..p {
        for t in 0..m_t {
            let cell = &mut beta_draws[j * m_t + t];
            beta_mean[(j, t)] = beta_sum[j * m_t + t] / q as f64;
            cell.sort_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));
            beta_lower[(j, t)] = quantile_sorted(cell, 0.025);
            beta_upper[(j, t)] = quantile_sorted(cell, 0.975);
        }
    }

    // ---- Fitted / residuals / σ²(t) ---------------------------------------
    // fitted(i,t) = mean_Y(t) + Σ_j x̃_ij · β̄_j(t)
    let mut fitted = FdMatrix::zeros(n, m_t);
    let mut residuals = FdMatrix::zeros(n, m_t);
    let mut sigma2_mean = vec![0.0f64; m_t];
    for t in 0..m_t {
        for i in 0..n {
            let mut val = fpca.mean[t];
            for j in 0..p {
                val += xc.column(j)[i] * beta_mean[(j, t)];
            }
            fitted[(i, t)] = val;
            let r = data[(i, t)] - val;
            residuals[(i, t)] = r;
            sigma2_mean[t] += r * r;
        }
        sigma2_mean[t] /= n as f64;
    }

    Ok(BayesianFosrResult {
        beta_mean,
        beta_lower,
        beta_upper,
        fitted,
        residuals,
        sigma2_mean,
        n_iter: config.n_iter,
        burn_in: config.burn_in,
        thin: config.thin,
        ncomp: k,
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_helpers::uniform_grid;
    use std::f64::consts::PI;

    fn default_config() -> BayesianConfig {
        BayesianConfig {
            ncomp: 4,
            tau2: 100.0,
            ig_a0: 0.001,
            ig_b0: 0.001,
            n_iter: 400,
            burn_in: 200,
            thin: 1,
            seed: 20260824,
        }
    }

    /// Y_i(t) = a(t) + x_i · β(t) + small noise, β(t) = sin(π t).
    fn make_fosr_dataset(n: usize, m: usize) -> (FdMatrix, FdMatrix, Vec<f64>) {
        let argvals = uniform_grid(m);
        let x1: Vec<f64> = (0..n)
            .map(|i| -1.0 + 2.0 * i as f64 / (n - 1).max(1) as f64)
            .collect();
        let predictors = FdMatrix::from_column_major(x1.clone(), n, 1).unwrap();

        let mut y = vec![0.0f64; n * m];
        for (t_idx, &tv) in argvals.iter().enumerate() {
            let a_t = 0.5 * (2.0 * PI * tv).cos(); // intercept function
            let beta_t = (PI * tv).sin(); // true coefficient
            for i in 0..n {
                let noise = 0.02 * ((i as f64 * 1.2345 + t_idx as f64 * 0.678).sin());
                y[i + t_idx * n] = a_t + x1[i] * beta_t + noise;
            }
        }
        (
            FdMatrix::from_column_major(y, n, m).unwrap(),
            predictors,
            argvals,
        )
    }

    #[test]
    fn bayesian_fosr_recovers_beta() {
        let (data, predictors, argvals) = make_fosr_dataset(60, 25);
        let result = bayesian_fosr(&data, &predictors, &argvals, &default_config()).unwrap();
        assert_eq!(result.beta_mean.shape(), (1, 25));
        // Posterior mean β̄(t) correlates strongly with the true sin(π t).
        let m = 25;
        let mut dot = 0.0;
        let mut nb = 0.0;
        let mut nt = 0.0;
        for t in 0..m {
            let tv = argvals[t];
            let truth = (PI * tv).sin();
            let est = result.beta_mean[(0, t)];
            dot += truth * est;
            nb += est * est;
            nt += truth * truth;
        }
        let corr = dot / (nb.sqrt() * nt.sqrt());
        assert!(
            corr > 0.9,
            "posterior mean β should track the true coefficient (corr={corr:.3})"
        );
    }

    #[test]
    fn bayesian_fosr_credible_bands_bracket_mean() {
        let (data, predictors, argvals) = make_fosr_dataset(50, 20);
        let result = bayesian_fosr(&data, &predictors, &argvals, &default_config()).unwrap();
        for t in 0..20 {
            let lo = result.beta_lower[(0, t)];
            let hi = result.beta_upper[(0, t)];
            let mean = result.beta_mean[(0, t)];
            assert!(lo <= mean + 1e-9, "lower band must be <= mean at t={t}");
            assert!(hi >= mean - 1e-9, "upper band must be >= mean at t={t}");
            assert!(lo.is_finite() && hi.is_finite());
        }
    }

    #[test]
    fn bayesian_fosr_is_deterministic_under_seed() {
        let (data, predictors, argvals) = make_fosr_dataset(40, 15);
        let cfg = default_config();
        let r1 = bayesian_fosr(&data, &predictors, &argvals, &cfg).unwrap();
        let r2 = bayesian_fosr(&data, &predictors, &argvals, &cfg).unwrap();
        assert_eq!(
            r1.beta_mean, r2.beta_mean,
            "same seed → identical posterior mean"
        );
        assert_eq!(r1.beta_lower, r2.beta_lower);
        assert_eq!(r1.beta_upper, r2.beta_upper);
        assert_eq!(r1.sigma2_mean, r2.sigma2_mean);
    }

    #[test]
    fn bayesian_fosr_sigma2_positive_and_shapes() {
        let (data, predictors, argvals) = make_fosr_dataset(40, 18);
        let result = bayesian_fosr(&data, &predictors, &argvals, &default_config()).unwrap();
        assert_eq!(result.fitted.shape(), (40, 18));
        assert_eq!(result.residuals.shape(), (40, 18));
        assert_eq!(result.sigma2_mean.len(), 18);
        assert!(result.sigma2_mean.iter().all(|&s| s > 0.0 && s.is_finite()));
    }

    #[test]
    fn bayesian_fosr_errors_on_dimension_mismatch() {
        let (data, _predictors, argvals) = make_fosr_dataset(30, 12);
        // predictors with wrong row count
        let bad = FdMatrix::from_column_major(vec![0.0; 10], 10, 1).unwrap();
        assert!(bayesian_fosr(&data, &bad, &argvals, &default_config()).is_err());
    }

    #[test]
    fn bayesian_fosr_errors_on_invalid_params() {
        let (data, predictors, argvals) = make_fosr_dataset(30, 12);
        let mut cfg = default_config();
        cfg.tau2 = -1.0;
        assert!(bayesian_fosr(&data, &predictors, &argvals, &cfg).is_err());
        let mut cfg2 = default_config();
        cfg2.ncomp = 0;
        assert!(bayesian_fosr(&data, &predictors, &argvals, &cfg2).is_err());
    }
}