devela 0.27.0

A development layer of coherence.
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

// devela::num::prob::rand::prng::shift
//
//! Pseudo-random number generators based on [Xorshift].
//!
//! This module defines several types:
//! - classic *XorShift* algorithms:
//!   ([`XorShift32`], [`XorShift64`], [`XorShift128`], [`XorShift128p`]).
//! - variations with a smaller state:
//!   ([`XorShift16`], [`XorShift8`]).
//!
//! - Original paper: <https://www.jstatsoft.org/article/view/v008i14>
//!
//! [Xorshift]: https://en.wikipedia.org/wiki/Xorshift
//

mod u128p; // XorShift128p (canonical)

#[cfg(feature = "rand")]
crate::items! {
    mod u8;   // ( 3,  4,  2)   (customizable)
    mod u16;  // ( 7,  9,  8)
    mod u32;  // ( 5, 17, 13)   (customizable, canonical default)
    mod u64;  // (13,  7, 17)   (customizable, canonical default)
    mod u128; // (11,  8, 19)   (canonical)
}
#[cfg(feature = "rand")]
mod macros;

crate::structural_mods! { // _mods, _hidden
    _mods {
        pub use super::{
            u128p::XorShift128p,
        };
        #[cfg(feature = "rand")]
        #[cfg_attr(nightly_doc, doc(cfg(feature = "rand")))]
        pub use super::{
            macros::define_xorshift,
            u8::XorShift8,
            u16::XorShift16,
            u32::XorShift32,
            u64::XorShift64,
            u128::XorShift128,
        };
    }
    _crate_internals {
        #[cfg(feature = "rand")]
        pub(crate) use super::{
            macros::xorshift_basis,
        };
    }
    _hidden {
        #[cfg(feature = "rand")]
        pub use super::{
            u16::XOROSHIFT_16_TRIPLETS,
            u32::XOROSHIFT_32_TRIPLETS,
            u64::XOROSHIFT_64_TRIPLETS,
        };
    }
}