urng 0.13.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

use wrapn::{Wrap, wrap};

use crate::{_internal::impl_seed, rng::Rng};

/// A SplitMix64 random number generator.
///
/// This is a fast generator with 64-bit state, often used for initializing
/// other generators from a single seed.
///
/// # Examples
///
/// ```
/// use urng::*;
///
/// let mut rng = SplitMix64::new(1);
/// assert_eq!(rng.nextu(), 10451216379200822465);
/// ```
#[repr(align(64))]
pub struct SplitMix64 {
    pub(crate) s: Wrap<u64>,
}

impl SplitMix64 {
    /// Creates a new `SplitMix64` instance.
    pub fn new(seed: u64) -> Self {
        Self { s: wrap!(seed | 1) }
    }

    /// Computes the SplitMix64 output for a given raw state word (pure, stateless).
    #[inline]
    pub(crate) fn compute(mut z: u64) -> u64 {
        z = (z ^ (z >> 30)).wrapping_mul(0xBF58476D1CE4E5B9);
        z = (z ^ (z >> 27)).wrapping_mul(0x94D049BB133111EB);
        z ^ (z >> 31)
    }
}

impl_seed!(SplitMix64, 64);

impl Rng for SplitMix64 {
    type Word = u64;
    #[inline]
    fn nextu(&mut self) -> u64 {
        self.s += 0x9E3779B97F4A7C15;
        Self::compute(self.s.value())
    }
}

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

    crate::safe_test!(SplitMix64);
}