cribler 0.1.0

Statistical randomness-test toolkit (chi-squared, serial, runs, KS, birthday spacing, NIST SP 800-22, paranoid meta-test). Batteries-included layer over cribler_core.
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

//! Named-case batching for [`cribler_core::run_paranoid`].

use std::collections::HashSet;

use cribler_core::{ParanoidConfig, ParanoidError, ParanoidResult, run_paranoid};

struct Case<'a> {
    name: String,
    trial: Box<dyn FnMut(usize) -> f64 + 'a>,
}

/// A suite that runs multiple named paranoid meta-test cases and collects
/// their [`ParanoidResult`]s. Bit-width-agnostic: cases are just p-value
/// producing closures, regardless of which underlying test they wrap.
#[derive(Default)]
pub struct ParanoidSuite<'a> {
    config: ParanoidConfig,
    cases: Vec<Case<'a>>,
}

impl<'a> ParanoidSuite<'a> {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn with_config(config: ParanoidConfig) -> Result<Self, ParanoidError> {
        config.validate()?;
        Ok(Self {
            config,
            cases: Vec::new(),
        })
    }

    pub fn config(&self) -> ParanoidConfig {
        self.config
    }

    pub fn set_config(&mut self, config: ParanoidConfig) -> Result<(), ParanoidError> {
        config.validate()?;
        self.config = config;
        Ok(())
    }

    pub fn len(&self) -> usize {
        self.cases.len()
    }

    pub fn is_empty(&self) -> bool {
        self.cases.is_empty()
    }

    pub fn clear(&mut self) {
        self.cases.clear();
    }

    /// Registers a named trial closure: `trial(i)` must return the p-value of
    /// the `i`-th independent run of the underlying test.
    pub fn add_trial<F>(
        &mut self,
        name: impl Into<String>,
        trial: F,
    ) -> Result<&mut Self, ParanoidError>
    where
        F: FnMut(usize) -> f64 + 'a,
    {
        let name = name.into();
        if name.trim().is_empty() {
            return Err(ParanoidError::EmptyCaseName);
        }
        self.cases.push(Case {
            name,
            trial: Box::new(trial),
        });
        Ok(self)
    }

    pub fn run(&mut self) -> Result<Vec<ParanoidResult>, ParanoidError> {
        let mut seen = HashSet::with_capacity(self.cases.len());
        let mut out = Vec::with_capacity(self.cases.len());
        for case in &mut self.cases {
            if !seen.insert(case.name.clone()) {
                return Err(ParanoidError::DuplicateCaseName {
                    name: case.name.clone(),
                });
            }
            let result = run_paranoid(case.name.clone(), self.config, case.trial.as_mut())?;
            out.push(result);
        }
        Ok(out)
    }
}