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

use wrapn::Wrap;

use crate::_internal::impl_seed;
use crate::rng::Rng64;
use crate::rng64::SplitMix64;

// --- Xorshift64 ---

/// A 64-bit Xorshift random number generator.
///
/// This generator uses a shift-register based algorithm.
///
/// # Examples
///
/// ```
/// use urng::rng::Rng64;
/// use urng::rng64::Xorshift64;
///
/// let mut rng = Xorshift64::new(1);
/// let _ = rng.nextu();
/// ```
#[repr(C)]
pub struct Xorshift64 {
    a: Wrap<u64>,
}

impl Xorshift64 {
    /// Creates a new `Xorshift64` instance.
    pub fn new(seed: u64) -> Self {
        let mut seedgen = SplitMix64::new(seed);
        Self {
            a: seedgen.nextu().into(),
        }
    }
}

impl_seed!(Xorshift64, 64);

impl Rng64 for Xorshift64 {
    #[inline]
    fn nextu(&mut self) -> u64 {
        let mut x = self.a;
        x ^= x << 13;
        x ^= x >> 7;
        x ^= x << 17;
        self.a = x;
        x.value()
    }
}

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

    crate::safe_test!(Xorshift64);
}