urng 0.9.0

Universal Random Number Generator
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

//! Convenience trait to run statistical tests directly on an RNG instance,
//! without manually constructing a [`crate::testing::ChiSq32`]/[`crate::testing::McPi32`] harness.

use crate::rng::{Rng32, Rng64};
use crate::testing::chisq::{ChiSq32, ChiSq64, ChiSqConfig, ChiSqError, ChiSqResult};
use crate::testing::mcpi::{McPi32, McPi64, McPiConfig, McPiError, McPiResult};

macro_rules! impl_test_for_rng {
    ($bits:expr) => {
        paste::paste! {
            #[doc = concat!("Adds `run_chisq`/`run_mcpi` helpers to any ", $bits, "-bit RNG.")]
            ///
            /// # Examples
            ///
            /// ```
            /// use urng::*;
            /// use urng::testing::{ChiSqVerdict, Test32};
            ///
            /// let mut rng = Sfc32::new(0);
            /// let result = rng.run_chisq("sfc32").unwrap();
            /// assert_eq!(result.verdict, ChiSqVerdict::Pass);
            /// ```
            pub trait [<Test $bits>]: [<Rng $bits>] + Sized {
                #[doc = concat!("Runs a chi-squared uniformity test on `self` with the default [`ChiSqConfig`].")]
                fn run_chisq(&mut self, name: impl Into<String>) -> Result<ChiSqResult, ChiSqError> {
                    [<ChiSq $bits>]::from_urng(self).run(name)
                }

                #[doc = concat!("Runs a chi-squared uniformity test on `self` with a custom [`ChiSqConfig`].")]
                fn run_chisq_with_config(
                    &mut self,
                    name: impl Into<String>,
                    config: ChiSqConfig,
                ) -> Result<ChiSqResult, ChiSqError> {
                    [<ChiSq $bits>]::with_config(self, config)?.run(name)
                }

                #[doc = concat!("Runs a Monte Carlo estimation of \u{3c0} on `self` with the default [`McPiConfig`].")]
                fn run_mcpi(&mut self, name: impl Into<String>) -> Result<McPiResult, McPiError> {
                    [<McPi $bits>]::from_urng(self).run(name)
                }

                #[doc = concat!("Runs a Monte Carlo estimation of \u{3c0} on `self` with a custom [`McPiConfig`].")]
                fn run_mcpi_with_config(
                    &mut self,
                    name: impl Into<String>,
                    config: McPiConfig,
                ) -> Result<McPiResult, McPiError> {
                    [<McPi $bits>]::with_config(self, config)?.run(name)
                }
            }

            impl<T: [<Rng $bits>]> [<Test $bits>] for T {}
        }
    };
}

impl_test_for_rng!(32);
impl_test_for_rng!(64);

#[cfg(test)]
mod tests {
    use super::*;
    use crate::testing::chisq::ChiSqVerdict;
    use crate::testing::mcpi::McPiVerdict;
    use crate::{Sfmt19937, Sfmt1993764};

    #[test]
    fn test32_run_chisq_works() {
        let mut rng = Sfmt19937::new(0);
        let res = rng.run_chisq(stringify!(Sfmt19937)).unwrap();
        assert_eq!(res.verdict, ChiSqVerdict::Pass);
    }

    #[test]
    fn test32_run_mcpi_works() {
        let mut rng = Sfmt19937::new(0);
        let res = rng.run_mcpi(stringify!(Sfmt19937)).unwrap();
        assert_eq!(res.verdict, McPiVerdict::Pass);
    }

    #[test]
    fn test64_run_chisq_works() {
        let mut rng = Sfmt1993764::new(0);
        let res = rng.run_chisq(stringify!(Sfmt1993764)).unwrap();
        assert_eq!(res.verdict, ChiSqVerdict::Pass);
    }

    #[test]
    fn test64_run_mcpi_works() {
        let mut rng = Sfmt1993764::new(0);
        let res = rng.run_mcpi(stringify!(Sfmt1993764)).unwrap();
        assert_eq!(res.verdict, McPiVerdict::Pass);
    }

    /// Regression test: Philox32x4/Threefry32x4/Threefry32x2/Philox64 now
    /// implement Rng32/Rng64 directly (internal ring buffer over their
    /// block-generation), so they participate in the shared Test32/Test64
    /// harness with no special-casing.
    #[test]
    fn block_generators_work_with_test_harness() {
        use crate::rng64::Philox64;
        use crate::{Philox32x4, Threefry32x2, Threefry32x4};

        let mut rng = Philox32x4::new(0);
        assert_eq!(
            rng.run_chisq("Philox32x4").unwrap().verdict,
            ChiSqVerdict::Pass
        );

        let mut rng = Threefry32x4::new(0);
        assert_eq!(
            rng.run_chisq("Threefry32x4").unwrap().verdict,
            ChiSqVerdict::Pass
        );

        let mut rng = Threefry32x2::new(0);
        assert_eq!(
            rng.run_chisq("Threefry32x2").unwrap().verdict,
            ChiSqVerdict::Pass
        );

        let mut rng = Philox64::new(0);
        assert_eq!(
            rng.run_chisq("Philox64").unwrap().verdict,
            ChiSqVerdict::Pass
        );
    }
}