Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to Wyrand #14

Merged
merged 2 commits into from Jul 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.toml
Expand Up @@ -8,7 +8,7 @@ license = "Apache-2.0 OR MIT"
repository = "https://github.com/smol-rs/fastrand"
homepage = "https://github.com/smol-rs/fastrand"
documentation = "https://docs.rs/fastrand"
keywords = ["simple", "fast", "rand", "random", "pcg"]
keywords = ["simple", "fast", "rand", "random", "wyrand"]
categories = ["algorithms"]

[target.'cfg(target_arch = "wasm32")'.dependencies]
Expand All @@ -21,5 +21,5 @@ getrandom = { version = "0.2", features = ["js"] }

[dev-dependencies]
rand = "0.8"
rand_pcg = "0.3"
wyhash = "0.5.0"
getrandom = "0.2"
6 changes: 2 additions & 4 deletions README.md
Expand Up @@ -11,10 +11,8 @@ https://docs.rs/fastrand)

A simple and fast random number generator.

The implementation uses [PCG XSH RR 64/32][paper], a simple and fast generator but **not**
cryptographically secure.

[paper]: https://www.pcg-random.org/pdf/hmc-cs-2014-0905.pdf
The implementation uses [Wyrand](https://github.com/wangyi-fudan/wyhash), a simple and fast
generator but **not** cryptographically secure.

## Examples

Expand Down
18 changes: 9 additions & 9 deletions benches/bench.rs
Expand Up @@ -3,13 +3,13 @@
extern crate test;

use rand::prelude::*;
use rand_pcg::Pcg32;
use test::Bencher;
use wyhash::WyRng;

#[bench]
fn shuffle_rand_pcg32(b: &mut Bencher) {
let mut rng = Pcg32::from_rng(thread_rng()).unwrap();
let mut x = (0..100).collect::<Vec::<usize>>();
fn shuffle_wyhash(b: &mut Bencher) {
let mut rng = WyRng::from_rng(thread_rng()).unwrap();
let mut x = (0..100).collect::<Vec<usize>>();
b.iter(|| {
x.shuffle(&mut rng);
x[0]
Expand All @@ -19,16 +19,16 @@ fn shuffle_rand_pcg32(b: &mut Bencher) {
#[bench]
fn shuffle_fastrand(b: &mut Bencher) {
let rng = fastrand::Rng::new();
let mut x = (0..100).collect::<Vec::<usize>>();
let mut x = (0..100).collect::<Vec<usize>>();
b.iter(|| {
rng.shuffle(&mut x);
x[0]
})
}

#[bench]
fn u8_rand_pcg32(b: &mut Bencher) {
let mut rng = Pcg32::from_rng(thread_rng()).unwrap();
fn u8_wyhash(b: &mut Bencher) {
let mut rng = WyRng::from_rng(thread_rng()).unwrap();
b.iter(|| {
let mut sum = 0u8;
for _ in 0..10_000 {
Expand All @@ -51,8 +51,8 @@ fn u8_fastrand(b: &mut Bencher) {
}

#[bench]
fn u32_rand_pcg32(b: &mut Bencher) {
let mut rng = Pcg32::from_rng(thread_rng()).unwrap();
fn u32_wyhash(b: &mut Bencher) {
let mut rng = WyRng::from_rng(thread_rng()).unwrap();
b.iter(|| {
let mut sum = 0u32;
for _ in 0..10_000 {
Expand Down
24 changes: 9 additions & 15 deletions src/lib.rs
@@ -1,9 +1,7 @@
//! A simple and fast random number generator.
//!
//! The implementation uses [PCG XSH RR 64/32][paper], a simple and fast generator but **not**
//! cryptographically secure.
//!
//! [paper]: https://www.pcg-random.org/pdf/hmc-cs-2014-0905.pdf
//! The implementation uses [Wyrand](https://github.com/wangyi-fudan/wyhash), a simple and fast
//! generator but **not** cryptographically secure.
//!
//! # Examples
//!
Expand Down Expand Up @@ -122,25 +120,22 @@ impl Rng {
/// Generates a random `u32`.
#[inline]
fn gen_u32(&self) -> u32 {
// Adapted from: https://en.wikipedia.org/wiki/Permuted_congruential_generator
let s = self.0.get();
self.0.set(
s.wrapping_mul(6364136223846793005)
.wrapping_add(1442695040888963407),
);
(((s ^ (s >> 18)) >> 27) as u32).rotate_right((s >> 59) as u32)
self.gen_u64() as u32
}

/// Generates a random `u64`.
#[inline]
fn gen_u64(&self) -> u64 {
((self.gen_u32() as u64) << 32) | (self.gen_u32() as u64)
let s = self.0.get().wrapping_add(0xA0761D6478BD642F);
self.0.set(s);
let t = u128::from(s) * u128::from(s ^ 0xE7037ED1A0B428DB);
(t as u64) ^ (t >> 64) as u64
}

/// Generates a random `u128`.
#[inline]
fn gen_u128(&self) -> u128 {
((self.gen_u64() as u128) << 64) | (self.gen_u64() as u128)
(u128::from(self.gen_u64()) << 64) | u128::from(self.gen_u64())
}

/// Generates a random `u32` in `0..n`.
Expand Down Expand Up @@ -421,8 +416,7 @@ impl Rng {
/// Initializes this generator with the given seed.
#[inline]
pub fn seed(&self, seed: u64) {
self.0.set(seed.wrapping_add(1442695040888963407));
self.gen_u32();
self.0.set(seed);
}

/// Shuffles a slice randomly.
Expand Down