Switch SmallRng to Pcg, and use release version of rand_core

Author: dhardy

Cargo.toml

@@ -31,7 +31,10 @@ serde1 = ["rand_core/serde1", "rand_isaac/serde1", "rand_xorshift/serde1"] # ena
 members = ["rand_core", "rand_isaac", "rand_chacha", "rand_hc128", "rand_xorshift"]
 
 [dependencies]
-rand_core = { path = "rand_core", version = "0.3", default-features = false }
+# Note: we can't use rand_core from a path at the same time as using rand_pcg
+# which uses rand_core from a crates.io release.
+rand_core = { version = "0.3", default-features = false }
+rand_pcg = { version = "0.1" }
 # only for deprecations and benches:
 rand_isaac = { path = "rand_isaac", version = "0.1" }
 rand_chacha = { path = "rand_chacha", version = "0.1" }

rand_chacha/Cargo.toml

@@ -19,7 +19,7 @@ travis-ci = { repository = "rust-random/rand" }
 appveyor = { repository = "rust-random/rand" }
 
 [dependencies]
-rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false }
+rand_core = { version = ">=0.2, <0.4", default-features=false }
 
 [build-dependencies]
 rustc_version = "0.2"

rand_hc128/Cargo.toml

@@ -18,4 +18,4 @@ travis-ci = { repository = "rust-random/rand" }
 appveyor = { repository = "rust-random/rand" }
 
 [dependencies]
-rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false }
+rand_core = { version = ">=0.2, <0.4", default-features=false }

rand_isaac/Cargo.toml

@@ -21,7 +21,7 @@ appveyor = { repository = "rust-random/rand" }
 serde1 = ["serde", "serde_derive", "rand_core/serde1"]
 
 [dependencies]
-rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false }
+rand_core = { version = ">=0.2, <0.4", default-features=false }
 serde = { version = "1", optional = true }
 serde_derive = { version = "^1.0.38", optional = true }
 

rand_xorshift/Cargo.toml

@@ -21,7 +21,7 @@ appveyor = { repository = "rust-random/rand" }
 serde1 = ["serde", "serde_derive"]
 
 [dependencies]
-rand_core = { path = "../rand_core", version = ">=0.2, <0.4", default-features=false }
+rand_core = { version = ">=0.2, <0.4", default-features=false }
 serde = { version = "1", optional = true }
 serde_derive = { version = "^1.0.38", optional = true }
 

src/lib.rs

@@ -245,6 +245,7 @@ extern crate rand_core;
 extern crate rand_isaac;    // only for deprecations
 extern crate rand_chacha;    // only for deprecations
 extern crate rand_hc128;
+extern crate rand_pcg;
 extern crate rand_xorshift;
 
 #[cfg(feature = "log")] #[macro_use] extern crate log;

src/rngs/mod.rs

@@ -48,9 +48,6 @@
 //!
 //! - [`SmallRng`] is a PRNG chosen for low memory usage, high performance and
 //!   good statistical quality.
-//!   The current algorithm (plain Xorshift) unfortunately performs
-//!   poorly in statistical quality test suites (TestU01 and PractRand) and will
-//!   be replaced in the next major release.
 //! - [`StdRng`] is a CSPRNG chosen for good performance and trust of security
 //!   (based on reviews, maturity and usage). The current algorithm is HC-128,
 //!   which is one of the recommendations by ECRYPT's eSTREAM project.

src/rngs/small.rs

@@ -9,7 +9,11 @@
 //! A small fast RNG
 
 use {RngCore, SeedableRng, Error};
-use ::rand_xorshift::XorShiftRng;
+
+#[cfg(all(rust_1_26, target_pointer_width = "64"))]
+type Rng = ::rand_pcg::Pcg64Mcg;
+#[cfg(not(all(rust_1_26, target_pointer_width = "64")))]
+type Rng = ::rand_pcg::Pcg32;
 
 /// An RNG recommended when small state, cheap initialization and good
 /// performance are required. The PRNG algorithm in `SmallRng` is chosen to be
@@ -20,9 +24,12 @@ use ::rand_xorshift::XorShiftRng;
 /// future library versions may use a different internal generator with
 /// different output. Further, this generator may not be portable and can
 /// produce different output depending on the architecture. If you require
-/// reproducible output, use a named RNG, for example [`XorShiftRng`].
+/// reproducible output, use a named RNG. Refer to the documentation on the
+/// [`prng` module](../../prng.index.html) or the
+/// [small-rngs repo](https://github.com/rust-random/small-rngs).
 ///
-/// The current algorithm used on all platforms is [Xorshift].
+/// The current algorithm is [`Pcg64Mcg`] on 64-bit platforms with Rust version
+/// 1.26 and later, or [`Pcg32`] otherwise.
 ///
 /// # Examples
 ///
@@ -61,10 +68,10 @@ use ::rand_xorshift::XorShiftRng;
 /// [`FromEntropy`]: ../trait.FromEntropy.html
 /// [`StdRng`]: struct.StdRng.html
 /// [`thread_rng`]: ../fn.thread_rng.html
-/// [Xorshift]: ../../rand_xorshift/struct.XorShiftRng.html
-/// [`XorShiftRng`]: ../../rand_xorshift/struct.XorShiftRng.html
+/// [`Pcg64Mcg`]: https://docs.rs/rand_pcg/0.1.0/rand_pcg/type.Pcg64Mcg.html
+/// [`Pcg32`]: https://docs.rs/rand_pcg/0.1.0/rand_pcg/type.Pcg32.html
 #[derive(Clone, Debug)]
-pub struct SmallRng(XorShiftRng);
+pub struct SmallRng(Rng);
 
 impl RngCore for SmallRng {
     #[inline(always)]
@@ -87,13 +94,13 @@ impl RngCore for SmallRng {
 }
 
 impl SeedableRng for SmallRng {
-    type Seed = <XorShiftRng as SeedableRng>::Seed;
+    type Seed = <Rng as SeedableRng>::Seed;
 
     fn from_seed(seed: Self::Seed) -> Self {
-        SmallRng(XorShiftRng::from_seed(seed))
+        SmallRng(Rng::from_seed(seed))
     }
 
     fn from_rng<R: RngCore>(rng: R) -> Result<Self, Error> {
-        XorShiftRng::from_rng(rng).map(SmallRng)
+        Rng::from_rng(rng).map(SmallRng)
     }
 }