anapao 0.1.1

Library for deterministic simulation tests and reproducible stochastic workflows
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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
//! Deterministic summary statistics utilities for simulation outputs.

use std::collections::BTreeMap;

use crate::types::{ConfidenceLevel, MetricKey, PredictionMetricIndicators};

#[derive(Debug, Clone, PartialEq)]
/// Streaming moments computed with Welford's online algorithm.
pub struct StreamingMomentsSummary {
    pub n: usize,
    pub mean: f64,
    pub variance: f64,
    pub std_dev: f64,
    pub min: f64,
    pub max: f64,
}

#[derive(Debug, Clone, PartialEq)]
/// Summary statistics computed from a sample vector.
pub struct StatsSummary {
    pub n: usize,
    pub mean: f64,
    pub variance: f64,
    pub std_dev: f64,
    pub min: f64,
    pub max: f64,
    pub p50: f64,
    pub p90: f64,
    pub p95: f64,
    pub p99: f64,
}

#[derive(Debug, Clone, Copy)]
struct WelfordAccumulator {
    n: usize,
    mean: f64,
    m2: f64,
    min: f64,
    max: f64,
}

impl WelfordAccumulator {
    fn new() -> Self {
        Self { n: 0, mean: 0.0, m2: 0.0, min: f64::INFINITY, max: f64::NEG_INFINITY }
    }

    fn push(&mut self, value: f64) -> bool {
        if !value.is_finite() {
            return false;
        }

        if self.n == 0 {
            self.n = 1;
            self.mean = value;
            self.m2 = 0.0;
            self.min = value;
            self.max = value;
            return true;
        }

        self.n += 1;
        let n = self.n as f64;
        let delta = value - self.mean;
        self.mean += delta / n;
        let delta2 = value - self.mean;
        self.m2 += delta * delta2;
        self.min = self.min.min(value);
        self.max = self.max.max(value);
        true
    }

    fn finalize(self) -> Option<StreamingMomentsSummary> {
        if self.n == 0 {
            return None;
        }

        let variance = (self.m2 / self.n as f64).max(0.0);
        Some(StreamingMomentsSummary {
            n: self.n,
            mean: self.mean,
            variance,
            std_dev: variance.sqrt(),
            min: self.min,
            max: self.max,
        })
    }
}

/// Computes streaming moments in one pass without retaining all values.
pub fn summarize_streaming<I>(values: I) -> Option<StreamingMomentsSummary>
where
    I: IntoIterator<Item = f64>,
{
    let mut accumulator = WelfordAccumulator::new();
    for value in values {
        if !accumulator.push(value) {
            return None;
        }
    }
    accumulator.finalize()
}

/// Computes descriptive statistics for finite values.
pub fn summarize(values: &[f64]) -> Option<StatsSummary> {
    let summary = summarize_streaming(values.iter().copied())?;

    let mut sorted_values = values.to_vec();
    sorted_values.sort_by(f64::total_cmp);

    Some(StatsSummary {
        n: summary.n,
        mean: summary.mean,
        variance: summary.variance,
        std_dev: summary.std_dev,
        min: summary.min,
        max: summary.max,
        p50: percentile_sorted(&sorted_values, 50.0)?,
        p90: percentile_sorted(&sorted_values, 90.0)?,
        p95: percentile_sorted(&sorted_values, 95.0)?,
        p99: percentile_sorted(&sorted_values, 99.0)?,
    })
}

/// Returns a percentile from a sorted finite slice using linear interpolation.
pub fn percentile_sorted(sorted_values: &[f64], percentile: f64) -> Option<f64> {
    if sorted_values.is_empty()
        || !percentile.is_finite()
        || !(0.0..=100.0).contains(&percentile)
        || sorted_values.iter().any(|value| !value.is_finite())
    {
        return None;
    }

    if sorted_values.windows(2).any(|window| window[0] > window[1]) {
        return None;
    }

    if sorted_values.len() == 1 {
        return Some(sorted_values[0]);
    }

    let rank = (percentile / 100.0) * (sorted_values.len() - 1) as f64;
    let lower_index = rank.floor() as usize;
    let upper_index = rank.ceil() as usize;

    if lower_index == upper_index {
        return Some(sorted_values[lower_index]);
    }

    let fraction = rank - lower_index as f64;
    let lower = sorted_values[lower_index];
    let upper = sorted_values[upper_index];
    Some(lower + (upper - lower) * fraction)
}

/// Computes summaries for each metric, dropping invalid metric samples.
pub fn summarize_by_metric(
    values_by_metric: BTreeMap<MetricKey, Vec<f64>>,
) -> BTreeMap<MetricKey, StatsSummary> {
    values_by_metric
        .into_iter()
        .filter_map(|(metric, values)| summarize(&values).map(|summary| (metric, summary)))
        .collect()
}

/// Computes a confidence interval around the sample mean for a configured confidence level.
pub fn mean_confidence_interval(
    values: &[f64],
    confidence_level: ConfidenceLevel,
) -> Option<(f64, f64)> {
    let summary = summarize(values)?;
    if summary.n == 1 {
        return Some((summary.mean, summary.mean));
    }

    let n = summary.n as f64;
    let sample_variance = summary.variance * n / (n - 1.0);
    let standard_error = sample_variance.sqrt() / n.sqrt();
    let margin = confidence_level.z_score() * standard_error;
    Some((summary.mean - margin, summary.mean + margin))
}

/// Computes a 95% confidence interval around the sample mean.
pub fn mean_confidence_interval_95(values: &[f64]) -> Option<(f64, f64)> {
    mean_confidence_interval(values, ConfidenceLevel::P95)
}

/// Derives prediction-oriented indicators for one metric sample and confidence level.
pub fn prediction_indicators_with_confidence(
    values: &[f64],
    confidence_level: ConfidenceLevel,
) -> Option<PredictionMetricIndicators> {
    let summary = summarize(values)?;
    let (confidence_lower_95, confidence_upper_95) = mean_confidence_interval_95(values)?;
    let confidence_margin_95 = (confidence_upper_95 - confidence_lower_95) / 2.0;
    let (confidence_lower_selected, confidence_upper_selected) =
        mean_confidence_interval(values, confidence_level)?;
    let confidence_margin_selected = (confidence_upper_selected - confidence_lower_selected) / 2.0;

    let convergence_delta = leading_trailing_delta(values)?;
    let baseline = summary.mean.abs() + 1.0;
    let relative_margin = confidence_margin_selected / baseline;
    let relative_dispersion = summary.std_dev / baseline;
    let reliability_score = 1.0 / (1.0 + relative_margin + relative_dispersion);

    Some(PredictionMetricIndicators {
        n: summary.n,
        mean: summary.mean,
        variance: summary.variance,
        std_dev: summary.std_dev,
        min: summary.min,
        max: summary.max,
        median: summary.p50,
        p90: summary.p90,
        p95: summary.p95,
        p99: summary.p99,
        confidence_lower_95,
        confidence_upper_95,
        confidence_margin_95,
        confidence_lower_selected,
        confidence_upper_selected,
        confidence_margin_selected,
        reliability_score,
        convergence_delta,
        convergence_ratio: convergence_delta / baseline,
    })
}

/// Derives prediction-oriented indicators for one metric sample using a 95% confidence interval.
pub fn prediction_indicators(values: &[f64]) -> Option<PredictionMetricIndicators> {
    prediction_indicators_with_confidence(values, ConfidenceLevel::P95)
}

/// Computes prediction indicators for each metric, dropping invalid samples.
pub fn prediction_indicators_by_metric_with_confidence(
    values_by_metric: BTreeMap<MetricKey, Vec<f64>>,
    confidence_level: ConfidenceLevel,
) -> BTreeMap<MetricKey, PredictionMetricIndicators> {
    values_by_metric
        .into_iter()
        .filter_map(|(metric, values)| {
            prediction_indicators_with_confidence(&values, confidence_level)
                .map(|summary| (metric, summary))
        })
        .collect()
}

/// Computes prediction indicators for each metric, dropping invalid samples.
pub fn prediction_indicators_by_metric(
    values_by_metric: BTreeMap<MetricKey, Vec<f64>>,
) -> BTreeMap<MetricKey, PredictionMetricIndicators> {
    prediction_indicators_by_metric_with_confidence(values_by_metric, ConfidenceLevel::P95)
}

fn leading_trailing_delta(values: &[f64]) -> Option<f64> {
    if values.is_empty() || values.iter().any(|value| !value.is_finite()) {
        return None;
    }

    if values.len() == 1 {
        return Some(0.0);
    }

    let window = (values.len() / 2).max(1);
    let leading = &values[..window];
    let trailing = &values[values.len() - window..];

    let leading_mean = leading.iter().sum::<f64>() / leading.len() as f64;
    let trailing_mean = trailing.iter().sum::<f64>() / trailing.len() as f64;
    Some((trailing_mean - leading_mean).abs())
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;

    use super::{
        mean_confidence_interval, mean_confidence_interval_95, percentile_sorted,
        prediction_indicators, prediction_indicators_by_metric,
        prediction_indicators_by_metric_with_confidence, prediction_indicators_with_confidence,
        summarize, summarize_by_metric, summarize_streaming,
    };
    use crate::types::{ConfidenceLevel, MetricKey};

    const EPSILON: f64 = 1e-12;

    fn assert_close(actual: f64, expected: f64) {
        assert!((actual - expected).abs() <= EPSILON, "expected {expected}, got {actual}");
    }

    #[test]
    fn summarize_returns_none_for_empty_input() {
        assert!(summarize(&[]).is_none());
    }

    #[test]
    fn summarize_streaming_returns_none_for_empty_or_non_finite_input() {
        assert!(summarize_streaming(std::iter::empty::<f64>()).is_none());
        assert!(summarize_streaming([1.0, f64::NAN].into_iter()).is_none());
    }

    #[test]
    fn summarize_streaming_clamps_negative_rounding_variance() {
        let summary =
            super::WelfordAccumulator { n: 4, mean: 1.0, m2: -f64::EPSILON, min: 1.0, max: 1.0 }
                .finalize()
                .expect("streaming summary");

        assert_close(summary.variance, 0.0);
        assert_close(summary.std_dev, 0.0);
    }

    #[test]
    fn percentile_sorted_uses_linear_interpolation() {
        let values = [1.0, 2.0, 3.0, 4.0];
        assert_close(percentile_sorted(&values, 0.0).expect("p0"), 1.0);
        assert_close(percentile_sorted(&values, 25.0).expect("p25"), 1.75);
        assert_close(percentile_sorted(&values, 50.0).expect("p50"), 2.5);
        assert_close(percentile_sorted(&values, 100.0).expect("p100"), 4.0);
    }

    #[test]
    fn summarize_computes_expected_values() {
        let values = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0];
        let summary = summarize(&values).expect("summary");

        assert_eq!(summary.n, 10);
        assert_close(summary.mean, 5.5);
        assert_close(summary.variance, 8.25);
        assert_close(summary.std_dev, 2.872_281_323_269_014_3);
        assert_close(summary.min, 1.0);
        assert_close(summary.max, 10.0);
        assert_close(summary.p50, 5.5);
        assert_close(summary.p90, 9.1);
        assert_close(summary.p95, 9.55);
        assert_close(summary.p99, 9.91);
    }

    #[test]
    fn summarize_streaming_matches_legacy_moments_with_deterministic_tolerance() {
        let values = (0..10_000)
            .map(|index| {
                let i = index as f64;
                (i * 0.37).sin() * 40.0 + (index % 17) as f64 - 8.0
            })
            .collect::<Vec<_>>();
        let streaming = summarize_streaming(values.iter().copied()).expect("streaming summary");

        let mean = values.iter().sum::<f64>() / values.len() as f64;
        let variance = values
            .iter()
            .map(|value| {
                let diff = *value - mean;
                diff * diff
            })
            .sum::<f64>()
            / values.len() as f64;
        let std_dev = variance.sqrt();
        let min = values.iter().copied().fold(f64::INFINITY, f64::min);
        let max = values.iter().copied().fold(f64::NEG_INFINITY, f64::max);

        assert_eq!(streaming.n, values.len());
        assert!((streaming.mean - mean).abs() <= 1e-10, "mean drifted");
        assert!((streaming.variance - variance).abs() <= 1e-10, "variance drifted");
        assert!((streaming.std_dev - std_dev).abs() <= 1e-10, "std_dev drifted");
        assert_close(streaming.min, min);
        assert_close(streaming.max, max);
    }

    #[test]
    fn summarize_streaming_accepts_large_iterators_without_collecting() {
        let n = 50_000_usize;
        let summary = summarize_streaming((1..=n).map(|value| value as f64))
            .expect("streaming summary from iterator");

        let n_f64 = n as f64;
        let expected_mean = (n_f64 + 1.0) / 2.0;
        let expected_variance = (n_f64 * n_f64 - 1.0) / 12.0;

        assert_eq!(summary.n, n);
        assert!((summary.mean - expected_mean).abs() <= 1e-9, "mean drifted");
        assert!((summary.variance - expected_variance).abs() <= 1e-3, "variance drifted");
        assert!((summary.std_dev - expected_variance.sqrt()).abs() <= 1e-9, "std_dev drifted");
        assert_close(summary.min, 1.0);
        assert_close(summary.max, n_f64);
    }

    #[test]
    fn summarize_and_streaming_moments_agree() {
        let values = [3.0, 8.0, 1.0, 4.0, 7.0];
        let summary = summarize(&values).expect("summary");
        let streaming = summarize_streaming(values).expect("streaming");

        assert_eq!(summary.n, streaming.n);
        assert_close(summary.mean, streaming.mean);
        assert_close(summary.variance, streaming.variance);
        assert_close(summary.std_dev, streaming.std_dev);
        assert_close(summary.min, streaming.min);
        assert_close(summary.max, streaming.max);
    }

    #[test]
    fn summarize_by_metric_keeps_deterministic_order() {
        let alpha = MetricKey::fixture("alpha");
        let beta = MetricKey::fixture("beta");
        let gamma = MetricKey::fixture("gamma");

        let values_by_metric = BTreeMap::from([
            (beta.clone(), vec![2.0, 4.0, 6.0, 8.0]),
            (gamma, vec![]),
            (alpha.clone(), vec![10.0, 20.0, 30.0]),
        ]);

        let summaries = summarize_by_metric(values_by_metric);
        let keys = summaries.keys().cloned().collect::<Vec<_>>();

        assert_eq!(keys, vec![alpha.clone(), beta.clone()]);
        assert_eq!(summaries.len(), 2);

        let alpha_summary = summaries.get(&alpha).expect("alpha summary");
        assert_eq!(alpha_summary.n, 3);
        assert_close(alpha_summary.mean, 20.0);
        assert_close(alpha_summary.p90, 28.0);

        let beta_summary = summaries.get(&beta).expect("beta summary");
        assert_eq!(beta_summary.n, 4);
        assert_close(beta_summary.mean, 5.0);
        assert_close(beta_summary.p95, 7.7);
    }

    #[test]
    fn mean_confidence_interval_95_matches_expected_values() {
        let values = [1.0, 2.0, 3.0, 4.0, 5.0];
        let (lower, upper) = mean_confidence_interval_95(&values).expect("ci95");
        assert_close(lower, 1.614_096_175_650_322);
        assert_close(upper, 4.385_903_824_349_678);
    }

    #[test]
    fn mean_confidence_interval_supports_90_95_and_99() {
        let values = [1.0, 2.0, 3.0, 4.0, 5.0];
        let (_, upper_90) = mean_confidence_interval(&values, ConfidenceLevel::P90).expect("ci90");
        let (_, upper_95) = mean_confidence_interval(&values, ConfidenceLevel::P95).expect("ci95");
        let (_, upper_99) = mean_confidence_interval(&values, ConfidenceLevel::P99).expect("ci99");
        assert!(upper_90 < upper_95);
        assert!(upper_95 < upper_99);
    }

    #[test]
    fn mean_confidence_interval_95_single_value_has_zero_width() {
        let (lower, upper) = mean_confidence_interval_95(&[42.0]).expect("ci95");
        assert_close(lower, 42.0);
        assert_close(upper, 42.0);
    }

    #[test]
    fn prediction_indicators_include_confidence_reliability_and_convergence() {
        let indicators = prediction_indicators(&[10.0, 12.0, 14.0, 16.0]).expect("indicators");

        assert_eq!(indicators.n, 4);
        assert_close(indicators.mean, 13.0);
        assert_close(indicators.variance, 5.0);
        assert_close(indicators.std_dev, 2.236_067_977_499_79);
        assert_close(indicators.min, 10.0);
        assert_close(indicators.max, 16.0);
        assert_close(indicators.median, 13.0);
        assert_close(indicators.p90, 15.4);
        assert_close(indicators.p95, 15.7);
        assert_close(indicators.p99, 15.94);
        assert_close(indicators.confidence_lower_95, 10.469_697_376_236_681);
        assert_close(indicators.confidence_upper_95, 15.530_302_623_763_319);
        assert_close(indicators.confidence_margin_95, 2.530_302_623_763_319);
        assert_close(indicators.confidence_lower_selected, 10.469_697_376_236_681);
        assert_close(indicators.confidence_upper_selected, 15.530_302_623_763_319);
        assert_close(indicators.confidence_margin_selected, 2.530_302_623_763_319);
        assert!(indicators.reliability_score > 0.0 && indicators.reliability_score <= 1.0);
        assert_close(indicators.convergence_delta, 4.0);
        assert_close(indicators.convergence_ratio, 0.285_714_285_714_285_7);
    }

    #[test]
    fn prediction_indicators_by_metric_keeps_sorted_keys_and_filters_invalid_metrics() {
        let alpha = MetricKey::fixture("alpha");
        let beta = MetricKey::fixture("beta");

        let values_by_metric = BTreeMap::from([
            (beta.clone(), vec![1.0, 2.0, 3.0, 4.0]),
            (MetricKey::fixture("gamma"), vec![1.0, f64::NAN]),
            (alpha.clone(), vec![10.0, 10.0, 10.0]),
        ]);

        let summaries = prediction_indicators_by_metric(values_by_metric);
        let keys = summaries.keys().cloned().collect::<Vec<_>>();
        assert_eq!(keys, vec![alpha.clone(), beta.clone()]);

        let alpha_summary = summaries.get(&alpha).expect("alpha summary");
        assert_close(alpha_summary.mean, 10.0);
        assert_close(alpha_summary.convergence_delta, 0.0);

        let beta_summary = summaries.get(&beta).expect("beta summary");
        assert_close(beta_summary.mean, 2.5);
        assert_close(beta_summary.convergence_delta, 2.0);
    }

    #[test]
    fn prediction_indicators_with_confidence_updates_margin() {
        let values = [10.0, 12.0, 14.0, 16.0];
        let p90 =
            prediction_indicators_with_confidence(&values, ConfidenceLevel::P90).expect("p90");
        let p95 =
            prediction_indicators_with_confidence(&values, ConfidenceLevel::P95).expect("p95");
        let p99 =
            prediction_indicators_with_confidence(&values, ConfidenceLevel::P99).expect("p99");

        assert_close(p90.confidence_margin_95, p95.confidence_margin_95);
        assert_close(p95.confidence_margin_95, p99.confidence_margin_95);
        assert!(p90.confidence_margin_selected < p95.confidence_margin_selected);
        assert!(p95.confidence_margin_selected < p99.confidence_margin_selected);
    }

    #[test]
    fn prediction_indicators_by_metric_with_confidence_updates_margin() {
        let metric = MetricKey::fixture("alpha");
        let values_by_metric = BTreeMap::from([(metric.clone(), vec![1.0, 2.0, 3.0, 4.0])]);

        let p90 = prediction_indicators_by_metric_with_confidence(
            values_by_metric.clone(),
            ConfidenceLevel::P90,
        );
        let p99 =
            prediction_indicators_by_metric_with_confidence(values_by_metric, ConfidenceLevel::P99);

        let alpha_90 = p90.get(&metric).expect("alpha p90");
        let alpha_99 = p99.get(&metric).expect("alpha p99");
        assert_close(alpha_90.confidence_margin_95, alpha_99.confidence_margin_95);
        assert!(alpha_90.confidence_margin_selected < alpha_99.confidence_margin_selected);
    }
}