rng-pack 0.2.3

Random number generator variety pack
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

/// A Twisted Generalized Feedback Shift Register (TGFSR) generator.
///
/// # Examples
///
/// ```
/// use rng_pack::twisted_gfsr::TwistedGFSR;
///
/// let seed = TwistedGFSR::new_seed();
/// let mut rng = TwistedGFSR::new(seed);
/// let val = rng.nextf();
/// ```
#[repr(C)]
pub struct TwistedGFSR {
    seed: [u64; N],
    index: usize,
}

const N: usize = 25;
const M: usize = 7;

impl TwistedGFSR {
    /// Provides a default seed array.
    pub const fn new_seed() -> [u64; N] {
        [
            0x95f24dab, 0x0b685215, 0xe76ccae7, 0xaf3ec239, 0x715fad23, 0x24a590ad, 0x69e4b5ef,
            0xbf456141, 0x96bc1b7b, 0xa7bdf825, 0xc1de75b7, 0x8858a9c9, 0x2da87693, 0xb657f9dd,
            0xffdc8a9f, 0x8121da71, 0x8b823ecb, 0x885d05f5, 0x4e20cd47, 0x5a9ad5d9, 0x512c0c03,
            0xea857ccd, 0x4cc1d30f, 0x8891a8a1, 0xa6b7aadb,
        ]
    }

    const fn mag01() -> [u64; 2] {
        [0x0, 0x8ebfd028]
    }

    /// Creates a new `TwistedGFSR` instance.
    ///
    /// # Arguments
    ///
    /// * `seed` - The initial state array.
    pub fn new(seed: [u64; N]) -> Self {
        Self { seed, index: N }
    }

    fn twist(&mut self) {
        for k in 0..(N - M) {
            self.seed[k] =
                self.seed[k + M] ^ (self.seed[k] >> 1) ^ Self::mag01()[(self.seed[k] & 1) as usize];
        }
        for k in (N - M)..N {
            self.seed[k] = self.seed[k + M - N]
                ^ (self.seed[k] >> 1)
                ^ Self::mag01()[(self.seed[k] & 1) as usize];
        }
        self.index = 0;
    }

    /// Generates the next random `u32` value.
    ///
    /// # Examples
    ///
    /// ```
    /// use rng_pack::twisted_gfsr::TwistedGFSR;
    ///
    /// let mut rng = TwistedGFSR::new(TwistedGFSR::new_seed());
    /// let val = rng.nextu();
    /// ```
    #[inline]
    pub fn nextu(&mut self) -> u32 {
        if self.index >= N {
            self.twist();
        }

        let mut y = self.seed[self.index];
        y ^= (y << 7) & 0x2b5b2500;
        y ^= (y << 15) & 0xdb8b0000;
        y &= 0xffffffff;
        y ^= y >> 16;

        self.index += 1;

        y as u32
    }

    /// Generates the next random `f64` value in the range [0, 1).
    ///
    /// # Examples
    ///
    /// ```
    /// use rng_pack::twisted_gfsr::TwistedGFSR;
    ///
    /// let mut rng = TwistedGFSR::new(TwistedGFSR::new_seed());
    /// let val = rng.nextf();
    /// assert!(val >= 0.0 && val < 1.0);
    /// ```
    #[inline]
    pub fn nextf(&mut self) -> f64 {
        self.nextu() as f64 * (1.0 / 4294967296.0)
    }

    /// Generates a random `i32` value in the range [min, max].
    ///
    /// # Arguments
    ///
    /// * `min` - The lower bound (inclusive).
    /// * `max` - The upper bound (inclusive).
    ///
    /// # Examples
    ///
    /// ```
    /// use rng_pack::twisted_gfsr::TwistedGFSR;
    ///
    /// let mut rng = TwistedGFSR::new(TwistedGFSR::new_seed());
    /// let val = rng.randi(1, 10);
    /// assert!(val >= 1 && val <= 10);
    /// ```
    #[inline]
    pub fn randi(&mut self, min: i32, max: i32) -> i32 {
        let range = (max as i64 - min as i64 + 1) as u64;
        let x = self.nextu();
        ((x as u64 * range) >> 32) as i32 + min
    }

    /// Generates a random `f64` value in the range [min, max).
    ///
    /// # Arguments
    ///
    /// * `min` - The lower bound (inclusive).
    /// * `max` - The upper bound (exclusive).
    ///
    /// # Examples
    ///
    /// ```
    /// use rng_pack::twisted_gfsr::TwistedGFSR;
    ///
    /// let mut rng = TwistedGFSR::new(TwistedGFSR::new_seed());
    /// let val = rng.randf(1.0, 10.0);
    /// assert!(val >= 1.0 && val < 10.0);
    /// ```
    #[inline]
    pub fn randf(&mut self, min: f64, max: f64) -> f64 {
        let range = max - min;
        self.nextf() * range + min
    }
}

#[cfg(test)]
mod tests {
    use crate::twisted_gfsr::TwistedGFSR;

    #[test]
    fn test_twisted_gfsr() {
        let rng = &mut TwistedGFSR::new(TwistedGFSR::new_seed());
        // Just check if it produces values in the correct range and doesn't panic.
        for _ in 0..1000 {
            let val = rng.nextf();
            assert!(val >= 0.0 && val < 1.0);
            let _ = rng.nextu();
            let i = rng.randi(-100, 100);
            assert!(i >= -100 && i <= 100);
            let f = rng.randf(-100.0, 100.0);
            assert!(f >= -100.0 && f < 100.0);
        }
    }
}