scirs2-stats 0.4.2

Statistical functions module for SciRS2 (scirs2-stats)
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
460
461
462
463
464
465
466
467
468
469
470
471
472
//! Conjugate prior distributions for Bayesian inference
//!
//! This module implements conjugate prior-posterior relationships for efficient Bayesian updates.

use crate::error::{StatsError, StatsResult as Result};
use scirs2_core::ndarray::{Array1, ArrayView1};
use scirs2_core::validation::*;
use statrs::statistics::Statistics;

/// Beta-Binomial conjugate pair
///
/// Prior: Beta(α, β)
/// Likelihood: Binomial(n, p)
/// Posterior: Beta(α + successes, β + failures)
#[derive(Debug, Clone)]
pub struct BetaBinomial {
    /// Alpha parameter of the Beta prior
    pub alpha: f64,
    /// Beta parameter of the Beta prior  
    pub beta: f64,
}

impl BetaBinomial {
    /// Create a new Beta-Binomial conjugate prior
    pub fn new(alpha: f64, beta: f64) -> Result<Self> {
        check_positive(alpha, "alpha")?;
        check_positive(beta, "beta")?;
        Ok(Self { alpha, beta })
    }

    /// Update the prior with observed data
    ///
    /// # Arguments
    /// * `successes` - Number of successes observed
    /// * `failures` - Number of failures observed
    ///
    /// # Returns
    /// Updated BetaBinomial with posterior parameters
    pub fn update(&self, successes: usize, failures: usize) -> Self {
        Self {
            alpha: self.alpha + successes as f64,
            beta: self.beta + failures as f64,
        }
    }

    /// Compute the posterior mean
    pub fn posterior_mean(&self) -> Result<f64> {
        let total = self.alpha + self.beta;
        if total.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior mean: alpha + beta too close to zero",
            ));
        }
        Ok(self.alpha / total)
    }

    /// Compute the posterior variance
    pub fn posterior_variance(&self) -> Result<f64> {
        let total = self.alpha + self.beta;
        if total.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior variance: alpha + beta too close to zero",
            ));
        }
        let denominator = total * total * (total + 1.0);
        if denominator.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior variance: denominator too close to zero",
            ));
        }
        Ok((self.alpha * self.beta) / denominator)
    }

    /// Compute the posterior mode (MAP estimate)
    pub fn posterior_mode(&self) -> Result<Option<f64>> {
        if self.alpha > 1.0 && self.beta > 1.0 {
            let denominator = self.alpha + self.beta - 2.0;
            if denominator.abs() < f64::EPSILON {
                return Err(StatsError::domain(
                    "Cannot compute posterior mode: alpha + beta - 2 too close to zero",
                ));
            }
            Ok(Some((self.alpha - 1.0) / denominator))
        } else {
            Ok(None)
        }
    }

    /// Compute credible interval
    pub fn credible_interval(&self, confidence: f64) -> Result<(f64, f64)> {
        check_probability(confidence, "confidence")?;

        // Use beta distribution quantiles
        use crate::distributions::beta::Beta;
        let dist = Beta::new(self.alpha, self.beta, 0.0, 1.0)?;

        let alpha_level = (1.0 - confidence) / 2.0;
        Ok((dist.ppf(alpha_level)?, dist.ppf(1.0 - alpha_level)?))
    }
}

/// Gamma-Poisson (Gamma-Negative Binomial) conjugate pair
///
/// Prior: Gamma(α, β)
/// Likelihood: Poisson(λ)
/// Posterior: Gamma(α + sum(data), β + n)
#[derive(Debug, Clone)]
pub struct GammaPoisson {
    /// Shape parameter of the Gamma prior
    pub alpha: f64,
    /// Rate parameter of the Gamma prior
    pub beta: f64,
}

impl GammaPoisson {
    /// Create a new Gamma-Poisson conjugate prior
    pub fn new(alpha: f64, beta: f64) -> Result<Self> {
        check_positive(alpha, "alpha")?;
        check_positive(beta, "beta")?;
        Ok(Self { alpha, beta })
    }

    /// Update the prior with observed count data
    ///
    /// # Arguments
    /// * `data` - Array of observed counts
    ///
    /// # Returns
    /// Updated GammaPoisson with posterior parameters
    pub fn update(&self, data: ArrayView1<f64>) -> Result<Self> {
        checkarray_finite(&data, "data")?;
        let sum: f64 = data.sum();
        let n = data.len() as f64;

        Ok(Self {
            alpha: self.alpha + sum,
            beta: self.beta + n,
        })
    }

    /// Compute the posterior mean
    pub fn posterior_mean(&self) -> Result<f64> {
        if self.beta.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior mean: beta too close to zero",
            ));
        }
        Ok(self.alpha / self.beta)
    }

    /// Compute the posterior variance
    pub fn posterior_variance(&self) -> Result<f64> {
        if self.beta.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior variance: beta too close to zero",
            ));
        }
        Ok(self.alpha / (self.beta * self.beta))
    }

    /// Compute the posterior mode (MAP estimate)
    pub fn posterior_mode(&self) -> Result<Option<f64>> {
        if self.alpha >= 1.0 {
            if self.beta.abs() < f64::EPSILON {
                return Err(StatsError::domain(
                    "Cannot compute posterior mode: beta too close to zero",
                ));
            }
            Ok(Some((self.alpha - 1.0) / self.beta))
        } else {
            Ok(None)
        }
    }

    /// Compute credible interval
    pub fn credible_interval(&self, confidence: f64) -> Result<(f64, f64)> {
        check_probability(confidence, "confidence")?;

        // Use gamma distribution quantiles
        use crate::distributions::gamma::Gamma;
        let dist = Gamma::new(self.alpha, 1.0 / self.beta, 0.0)?; // Note: using scale parameterization

        let alpha_level = (1.0 - confidence) / 2.0;
        Ok((dist.ppf(alpha_level)?, dist.ppf(1.0 - alpha_level)?))
    }
}

/// Normal-Normal conjugate pair with known variance
///
/// Prior: Normal(μ₀, σ₀²)
/// Likelihood: Normal(μ, σ²) with known σ²
/// Posterior: Normal(μₙ, σₙ²)
#[derive(Debug, Clone)]
pub struct NormalKnownVariance {
    /// Prior mean
    pub prior_mean: f64,
    /// Prior variance
    pub prior_variance: f64,
    /// Known data variance
    pub data_variance: f64,
}

impl NormalKnownVariance {
    /// Create a new Normal conjugate prior with known data variance
    pub fn new(prior_mean: f64, prior_variance: f64, data_variance: f64) -> Result<Self> {
        check_positive(prior_variance, "prior_variance")?;
        check_positive(data_variance, "data_variance")?;
        Ok(Self {
            prior_mean,
            prior_variance,
            data_variance,
        })
    }

    /// Update the prior with observed data
    ///
    /// # Arguments
    /// * `data` - Array of observed values
    ///
    /// # Returns
    /// Updated NormalKnownVariance with posterior parameters
    pub fn update(&self, data: ArrayView1<f64>) -> Result<Self> {
        checkarray_finite(&data, "data")?;
        let n = data.len() as f64;
        let data_mean = data.mean();

        if self.prior_variance.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot update: prior_variance too close to zero",
            ));
        }
        if self.data_variance.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot update: data_variance too close to zero",
            ));
        }

        let precision_prior = 1.0 / self.prior_variance;
        let precisiondata = n / self.data_variance;
        let precision_posterior = precision_prior + precisiondata;

        if precision_posterior.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot update: precision_posterior too close to zero",
            ));
        }

        let posterior_variance = 1.0 / precision_posterior;
        let posterior_mean =
            (precision_prior * self.prior_mean + precisiondata * data_mean) / precision_posterior;

        Ok(Self {
            prior_mean: posterior_mean,
            prior_variance: posterior_variance,
            data_variance: self.data_variance,
        })
    }

    /// Compute the posterior mean
    pub fn posterior_mean(&self) -> f64 {
        self.prior_mean
    }

    /// Compute the posterior variance
    pub fn posterior_variance(&self) -> f64 {
        self.prior_variance
    }

    /// Compute credible interval
    pub fn credible_interval(&self, confidence: f64) -> Result<(f64, f64)> {
        check_probability(confidence, "confidence")?;

        // Use normal distribution quantiles
        use crate::distributions::normal::Normal;
        if self.prior_variance < 0.0 {
            return Err(StatsError::domain(
                "Cannot compute credible interval: prior_variance must be non-negative",
            ));
        }
        let dist = Normal::new(self.prior_mean, self.prior_variance.sqrt())?;

        let alpha_level = (1.0 - confidence) / 2.0;
        Ok((dist.ppf(alpha_level)?, dist.ppf(1.0 - alpha_level)?))
    }

    /// Compute the predictive distribution parameters
    pub fn predictive_params(&self) -> (f64, f64) {
        (self.prior_mean, self.prior_variance + self.data_variance)
    }
}

/// Dirichlet-Multinomial conjugate pair
///
/// Prior: Dirichlet(α)
/// Likelihood: Multinomial(n, p)
/// Posterior: Dirichlet(α + counts)
#[derive(Debug, Clone)]
pub struct DirichletMultinomial {
    /// Concentration parameters of the Dirichlet prior
    pub alpha: Array1<f64>,
}

impl DirichletMultinomial {
    /// Create a new Dirichlet-Multinomial conjugate prior
    pub fn new(alpha: Array1<f64>) -> Result<Self> {
        checkarray_finite(&alpha, "alpha")?;
        for &a in alpha.iter() {
            check_positive(a, "_alpha element")?;
        }
        Ok(Self { alpha })
    }

    /// Create uniform prior with given dimension
    pub fn uniform(k: usize) -> Result<Self> {
        check_positive(k, "k")?;
        Ok(Self {
            alpha: Array1::from_elem(k, 1.0),
        })
    }

    /// Update the prior with observed count data
    ///
    /// # Arguments
    /// * `counts` - Array of observed counts for each category
    ///
    /// # Returns
    /// Updated DirichletMultinomial with posterior parameters
    pub fn update(&self, counts: ArrayView1<f64>) -> Result<Self> {
        if counts.len() != self.alpha.len() {
            return Err(StatsError::DimensionMismatch(format!(
                "counts length ({}) must match alpha length ({})",
                counts.len(),
                self.alpha.len()
            )));
        }
        checkarray_finite(&counts, "counts")?;

        Ok(Self {
            alpha: &self.alpha + &counts,
        })
    }

    /// Compute the posterior mean
    pub fn posterior_mean(&self) -> Result<Array1<f64>> {
        let sum = self.alpha.sum();
        if sum.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior mean: sum of alpha parameters too close to zero",
            ));
        }
        Ok(&self.alpha / sum)
    }

    /// Compute the posterior mode (MAP estimate)
    pub fn posterior_mode(&self) -> Result<Option<Array1<f64>>> {
        let k = self.alpha.len() as f64;
        if self.alpha.iter().all(|&a| a > 1.0) {
            let sum = self.alpha.sum();
            let denominator = sum - k;
            if denominator.abs() < f64::EPSILON {
                return Err(StatsError::domain(
                    "Cannot compute posterior mode: sum - k too close to zero",
                ));
            }
            Ok(Some((&self.alpha - 1.0) / denominator))
        } else {
            Ok(None)
        }
    }

    /// Compute the marginal variance for each component
    pub fn posterior_variance(&self) -> Result<Array1<f64>> {
        let sum = self.alpha.sum();
        let denominator = sum + 1.0;
        if denominator.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior variance: sum + 1 too close to zero",
            ));
        }
        let mean = self.posterior_mean()?;
        Ok(mean.mapv(|p| p * (1.0 - p) / denominator))
    }
}

/// Normal-Inverse-Gamma conjugate pair for unknown mean and variance
///
/// Prior: NIG(μ₀, λ, α, β)
/// Likelihood: Normal(μ, σ²) with both unknown
/// Posterior: NIG(μₙ, λₙ, αₙ, βₙ)
#[derive(Debug, Clone)]
pub struct NormalInverseGamma {
    /// Prior mean
    pub mu0: f64,
    /// Prior precision factor
    pub lambda: f64,
    /// Shape parameter
    pub alpha: f64,
    /// Scale parameter
    pub beta: f64,
}

impl NormalInverseGamma {
    /// Create a new Normal-Inverse-Gamma conjugate prior
    pub fn new(mu0: f64, lambda: f64, alpha: f64, beta: f64) -> Result<Self> {
        check_positive(lambda, "lambda")?;
        check_positive(alpha, "alpha")?;
        check_positive(beta, "beta")?;
        Ok(Self {
            mu0,
            lambda,
            alpha,
            beta,
        })
    }

    /// Update the prior with observed data
    pub fn update(&self, data: ArrayView1<f64>) -> Result<Self> {
        checkarray_finite(&data, "data")?;
        let n = data.len() as f64;
        let data_mean = data.mean();

        // Compute sum of squares
        let ss = data.mapv(|x| (x - data_mean).powi(2)).sum();

        // Update parameters
        let lambda_n = self.lambda + n;
        if lambda_n.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot update: lambda_n too close to zero",
            ));
        }
        let mu_n = (self.lambda * self.mu0 + n * data_mean) / lambda_n;
        let alpha_n = self.alpha + n / 2.0;
        let beta_n = self.beta
            + 0.5 * ss
            + 0.5 * self.lambda * n * (data_mean - self.mu0).powi(2) / lambda_n;

        Ok(Self {
            mu0: mu_n,
            lambda: lambda_n,
            alpha: alpha_n,
            beta: beta_n,
        })
    }

    /// Compute the posterior mean of μ
    pub fn posterior_mean_mu(&self) -> f64 {
        self.mu0
    }

    /// Compute the posterior mean of σ²
    pub fn posterior_mean_variance(&self) -> Result<f64> {
        let denominator = self.alpha - 1.0;
        if denominator.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior mean variance: alpha - 1 too close to zero",
            ));
        }
        Ok(self.beta / denominator)
    }

    /// Compute the marginal posterior variance of μ
    pub fn posterior_variance_mu(&self) -> Result<f64> {
        let denominator = self.lambda * (self.alpha - 1.0);
        if denominator.abs() < f64::EPSILON {
            return Err(StatsError::domain(
                "Cannot compute posterior variance mu: lambda * (alpha - 1) too close to zero",
            ));
        }
        Ok(self.beta / denominator)
    }
}