xorshift 0.1.3

Implementation of the high performance xoroshiro128+, xorshift128+, xorshift1024*, and splitmix64 pseudo random number generators.
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

// Written by Alexander Stocko <as@coder.gg>
//
// To the extent possible under law, the author has dedicated all copyright
// and related and neighboring rights to this software to the public domain
// worldwide. This software is distributed without any warranty.
//
// See <LICENSE or http://creativecommons.org/publicdomain/zero/1.0/>

//! The `SplitMix64` random number generator.

use std::num::Wrapping as w;
use rand::{Rand, Rng, SeedableRng};

/// A random number generator that uses the splitmix64 algorithm [1].
///
/// # Description
/// Quoted from [1].
///
/// This is a fixed-increment version of Java 8's `SplittableRandom`
/// generator [2] and [3].
///
/// It is a very fast generator passing `BigCrush`, and it can be useful if
/// for some reason you absolutely want 64 bits of state; otherwise, we
/// rather suggest to use a xoroshiro128+ (for moderately parallel
/// computations) or xorshift1024* (for massively parallel computations)
/// generator.
///
/// [1]: Sebastiano Vigna, [splitmix64]
/// (http://xoroshiro.di.unimi.it/splitmix64.c)
///
/// [2]: Guy L. Steele, Jr., Doug Lea, and Christine H. Flood. 2014.
/// [*Fast splittable pseudorandom number generators*]
/// (http://dx.doi.org/10.1145/2714064.2660195)
///
/// [3]: JavaSE, [SplittableRandom]
/// (http://docs.oracle.com/javase/8/docs/api/java/util/SplittableRandom.html)
#[derive(Copy, Clone)]
pub struct SplitMix64(u64);

impl Rng for SplitMix64 {
    #[inline]
    fn next_u32(&mut self) -> u32 {
        self.next_u64() as u32
    }

    #[inline]
    fn next_u64(&mut self) -> u64 {
        let mut z = w(self.0) + w(0x9E3779B97F4A7C15_u64);
        self.0 = z.0;
        z = (z ^ (z >> 30)) * w(0xBF58476D1CE4E5B9_u64);
        z = (z ^ (z >> 27)) * w(0x94D049BB133111EB_u64);
        (z ^ (z >> 31)).0
    }
}

impl SeedableRng<u64> for SplitMix64 {
    fn reseed(&mut self, seed: u64) {
        self.0 = seed;
    }

    fn from_seed(seed: u64) -> SplitMix64 {
        SplitMix64(seed)
    }
}

impl Rand for SplitMix64 {
    fn rand<R: Rng>(other: &mut R) -> SplitMix64 {
        SeedableRng::from_seed(other.gen())
    }
}


#[cfg(test)]
mod tests {
    use rand::{Rng, SeedableRng};
    use super::SplitMix64;
    #[test]
    fn test() {
        // Calculated from reference implementation
        // https://github.com/astocko/xorshift-cpp
        let seed: u64 = 1477776061723855037;
        let t_vals: Vec<u64> = vec![1985237415132408290,
                                    2979275885539914483,
                                    13511426838097143398,
                                    8488337342461049707,
                                    15141737807933549159,
                                    17093170987380407015,
                                    16389528042912955399,
                                    13177319091862933652,
                                    10841969400225389492,
                                    17094824097954834098,
                                    3336622647361835228,
                                    9678412372263018368,
                                    11111587619974030187,
                                    7882215801036322410,
                                    5709234165213761869,
                                    7799681907651786826,
                                    4616320717312661886,
                                    4251077652075509767,
                                    7836757050122171900,
                                    5054003328188417616,
                                    12919285918354108358,
                                    16477564761813870717,
                                    5124667218451240549,
                                    18099554314556827626,
                                    7603784838804469118,
                                    6358551455431362471,
                                    3037176434532249502,
                                    3217550417701719149,
                                    9958699920490216947,
                                    5965803675992506258,
                                    12000828378049868312,
                                    12720568162811471118,
                                    245696019213873792,
                                    8351371993958923852,
                                    14378754021282935786,
                                    5655432093647472106,
                                    5508031680350692005,
                                    8515198786865082103,
                                    6287793597487164412,
                                    14963046237722101617,
                                    3630795823534910476,
                                    8422285279403485710,
                                    10554287778700714153,
                                    10871906555720704584,
                                    8659066966120258468,
                                    9420238805069527062,
                                    10338115333623340156,
                                    13514802760105037173,
                                    14635952304031724449,
                                    15419692541594102413];

        let mut rng: SplitMix64 = SeedableRng::from_seed(seed);
        let vals = rng.gen_iter::<u64>().take(t_vals.len()).collect::<Vec<u64>>();
        assert!(::test::iter_eq(t_vals, vals));
    }
}