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

//! An implementation of a permeuted multiply with carry random number generator.
//! Details about the design see: https://tom-kaitchuck.medium.com/designing-a-new-prng-1c4ffd27124d
//!
//! This library provides two generators:
//!
//! * `Mwc256XXA64` : A Lag-3 64bit MWC generator with two xors and an addition applied to the output.
//!    It has an output size of 64bits, and a state size of 256bits. This algorithm is fastest on 64 bit architectures.
//! * `Mwc256XXA64` : A Lag-3 32bit MWC generator with two xors and an addition applied to the output.
//!    It has an output size of 32bits, and a state size of 128bits. This algorithm is fastest on 32 bit architectures.
//!
//!
//! # Usage
//!
//! ```toml
//! [dependencies]
//! pcg-mwq = "0.2.1"
//! ```
//! # Typename Nomenclature
//! The name describes the algorithm.
//!
//! 1. First Mwc stands for `Multiply with carry` this is the base generator type.
//! 1. This is followed by the state sise in bits.
//! 1. Third the output permutatuon which is used. Where `X` refers to 'xor' and `A` refers to addition.
//! 1. Fourth is the output size in bits
//!
//! # How to Use
//! The simple generators work like the other Rng's from the `rand` crate.
//! You can create a prng as follows
//!
//! ```ignore
//! extern crate pcg_mwc;
//! extern crate rand;
//!
//! use rand::{Rng, SeedableRng};
//! use pcg_mwc::Mwc256XXA64;
//!
//! fn main() {
//!     let mut rand = Mwc256XXA64::from_entropy();
//!
//!     let x : u32 = rand.gen();
//! }
//! ```
//!
mod gen32;
mod gen64;

pub use gen32::Mwc128XXA32;
pub use gen64::Mwc256XXA64;