urng 0.10.2

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

use wrapn::Wrap;

use crate::rng::Rng32;

// --- Lcg32 ---

/// A Linear Congruential Generator (LCG) for 32-bit random numbers.
///
/// This generator produces pseudo-random numbers using the recurrence relation:
/// X(n+1) = (a * X(n) + b) % M
///
/// # Examples
///
/// ```
/// use urng::rng::Rng32;
/// use urng::rng32::Lcg32;
///
/// let mut rng = Lcg32::new(8, 13, 5, 24);
/// let _ = rng.nextu();
/// ```
#[deprecated(since = "0.2.4", note = "Use Xoshiro256++/** instead.")]
#[repr(C)]
pub struct Lcg32 {
    x: Wrap<u32>,
    a: u32,
    b: u32,
    m: u32,
    r: f32,
}

#[allow(deprecated)]
impl Lcg32 {
    /// Creates a new `Lcg32` instance.
    ///
    pub fn new(x: u32, a: u32, b: u32, m: u32) -> Self {
        // M>a, M>b, A>0, B>=0
        Self {
            x: x.into(),
            a: a | 1,
            b,
            m,
            r: 1.0 / (m as f32 + 1.0),
        }
    }
}

#[allow(deprecated)]
impl Default for Lcg32 {
    fn default() -> Self {
        Self::new(8, 13, 5, 24)
    }
}

#[allow(deprecated)]
impl Rng32 for Lcg32 {
    /// Generates the next random `u32` value.
    #[inline]
    fn nextu(&mut self) -> u32 {
        // X(n+1) = (a * X(n) + b) % M
        self.x = (self.x * self.a + self.b) % self.m;
        *self.x.raw()
    }
}

#[allow(deprecated)]
#[cfg(test)]
mod tests {
    use super::*;

    crate::safe_test!(Lcg32, Lcg32::new(8, 13, 5, 24));
}