Merge pull request #802 from vks/xoshiro-release

dhardy · web-flow · commit 54545395a0e7 · 2019-05-28T09:24:02.000+01:00
Prepare rand_xoshiro for 0.2 release
diff --git a/Cargo.toml b/Cargo.toml
@@ -66,7 +66,7 @@ libc = { version = "0.2.22", default-features = false }
 
 [dev-dependencies]
 # Only for benches:
-rand_xoshiro = { path = "rand_xoshiro", version = "0.1" }
+rand_xoshiro = { path = "rand_xoshiro", version = "0.2" }
 rand_isaac = { path = "rand_isaac", version = "0.1" }
 rand_chacha = { path = "rand_chacha", version = "0.2" }
 rand_xorshift = { path = "rand_xorshift", version = "0.1" }
diff --git a/rand_xoshiro/CHANGELOG.md b/rand_xoshiro/CHANGELOG.md
@@ -4,5 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2019-05-28
+- Fix `seed_from_u64(0)` for `Xoroshiro64StarStar` and `Xoroshiro64Star`. This
+  breaks value stability for these generators if initialized with `seed_from_u64`.
+- Implement Serde support.
+
 ## [0.1.0] - 2019-01-04
 Initial release.
diff --git a/rand_xoshiro/Cargo.toml b/rand_xoshiro/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rand_xoshiro"
-version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.2.0" # NB: When modifying, also modify html_root_url in lib.rs
 authors = ["The Rand Project Developers"]
 license = "MIT/Apache-2.0"
 readme = "README.md"
@@ -11,9 +11,17 @@ description = "Xoshiro, xoroshiro and splitmix64 random number generators"
 keywords = ["random", "rng"]
 categories = ["algorithms"]
 
+[features]
+serde1 = ["serde", "serde_derive"]
+
 [dependencies]
 byteorder = { version = "1", default-features=false }
 rand_core = { path = "../rand_core", version = "0.4" }
+serde = { version = "1", optional=true }
+serde_derive = { version = "^1.0.38", optional=true }
 
 [dev-dependencies]
 rand = { path = "..", version = "0.6", default-features=false }  # needed for doctests
+# This is for testing serde, unfortunately we can't specify feature-gated dev
+# deps yet, see: https://github.com/rust-lang/cargo/issues/1596
+bincode = { version = "1" }
diff --git a/rand_xoshiro/src/lib.rs b/rand_xoshiro/src/lib.rs
@@ -58,14 +58,16 @@
 
 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
        html_favicon_url = "https://www.rust-lang.org/favicon.ico",
-       html_root_url = "https://docs.rs/rand_xoshiro/0.1.0")]
+       html_root_url = "https://docs.rs/rand_xoshiro/0.2.0")]
 
 #![deny(missing_docs)]
 #![deny(missing_debug_implementations)]
 #![cfg_attr(feature = "cargo-clippy", allow(unreadable_literal))]
 #![no_std]
 extern crate byteorder;
 pub extern crate rand_core;
+#[cfg(feature="serde1")] extern crate serde;
+#[cfg(feature="serde1")] #[macro_use] extern crate serde_derive;
 
 #[macro_use]
 mod common;
diff --git a/rand_xoshiro/src/splitmix64.rs b/rand_xoshiro/src/splitmix64.rs
@@ -22,6 +22,7 @@ use rand_core::{RngCore, SeedableRng, Error};
 /// from [`dsiutils`](http://dsiutils.di.unimi.it/) is used.
 #[allow(missing_copy_implementations)]
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct SplitMix64 {
     x: u64,
 }
diff --git a/rand_xoshiro/src/xoroshiro128plus.rs b/rand_xoshiro/src/xoroshiro128plus.rs
@@ -22,6 +22,7 @@ use rand_core::{RngCore, SeedableRng};
 /// David Blackman and Sebastiano Vigna.
 #[allow(missing_copy_implementations)]
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoroshiro128Plus {
     s0: u64,
     s1: u64,
diff --git a/rand_xoshiro/src/xoroshiro128starstar.rs b/rand_xoshiro/src/xoroshiro128starstar.rs
@@ -21,6 +21,7 @@ use rand_core::{RngCore, SeedableRng};
 /// David Blackman and Sebastiano Vigna.
 #[allow(missing_copy_implementations)]
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoroshiro128StarStar {
     s0: u64,
     s1: u64,
diff --git a/rand_xoshiro/src/xoroshiro64star.rs b/rand_xoshiro/src/xoroshiro64star.rs
@@ -22,6 +22,7 @@ use rand_core::{RngCore, SeedableRng};
 /// David Blackman and Sebastiano Vigna.
 #[allow(missing_copy_implementations)]
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoroshiro64Star {
     s0: u32,
     s1: u32,
diff --git a/rand_xoshiro/src/xoroshiro64starstar.rs b/rand_xoshiro/src/xoroshiro64starstar.rs
@@ -11,7 +11,7 @@ use rand_core::le::read_u32_into;
 use rand_core::impls::{fill_bytes_via_next, next_u64_via_u32};
 use rand_core::{RngCore, SeedableRng};
 
-/// A Xoroshiro64** random number generator.
+/// A xoroshiro64** random number generator.
 ///
 /// The xoshiro64** algorithm is not suitable for cryptographic purposes, but
 /// is very fast and has excellent statistical properties.
@@ -21,6 +21,7 @@ use rand_core::{RngCore, SeedableRng};
 /// David Blackman and Sebastiano Vigna.
 #[allow(missing_copy_implementations)]
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoroshiro64StarStar {
     s0: u32,
     s1: u32,
diff --git a/rand_xoshiro/src/xoshiro128plus.rs b/rand_xoshiro/src/xoshiro128plus.rs
@@ -20,6 +20,7 @@ use rand_core::{SeedableRng, RngCore, Error};
 /// reference source code](http://xoshiro.di.unimi.it/xoshiro128starstar.c) by
 /// David Blackman and Sebastiano Vigna.
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoshiro128Plus {
     s: [u32; 4],
 }
diff --git a/rand_xoshiro/src/xoshiro128starstar.rs b/rand_xoshiro/src/xoshiro128starstar.rs
@@ -19,6 +19,7 @@ use rand_core::{SeedableRng, RngCore, Error};
 /// reference source code](http://xoshiro.di.unimi.it/xoshiro128starstar.c) by
 /// David Blackman and Sebastiano Vigna.
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoshiro128StarStar {
     s: [u32; 4],
 }
diff --git a/rand_xoshiro/src/xoshiro256plus.rs b/rand_xoshiro/src/xoshiro256plus.rs
@@ -20,6 +20,7 @@ use rand_core::{SeedableRng, RngCore, Error};
 /// reference source code](http://xoshiro.di.unimi.it/xoshiro256plus.c) by
 /// David Blackman and Sebastiano Vigna.
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoshiro256Plus {
     s: [u64; 4],
 }
diff --git a/rand_xoshiro/src/xoshiro256starstar.rs b/rand_xoshiro/src/xoshiro256starstar.rs
@@ -19,6 +19,7 @@ use rand_core::{SeedableRng, RngCore, Error};
 /// reference source code](http://xoshiro.di.unimi.it/xoshiro256starstar.c) by
 /// David Blackman and Sebastiano Vigna.
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoshiro256StarStar {
     s: [u64; 4],
 }
diff --git a/rand_xoshiro/src/xoshiro512plus.rs b/rand_xoshiro/src/xoshiro512plus.rs
@@ -22,6 +22,7 @@ use Seed512;
 /// reference source code](http://xoshiro.di.unimi.it/xoshiro512plus.c) by
 /// David Blackman and Sebastiano Vigna.
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoshiro512Plus {
     s: [u64; 8],
 }
diff --git a/rand_xoshiro/src/xoshiro512starstar.rs b/rand_xoshiro/src/xoshiro512starstar.rs
@@ -21,6 +21,7 @@ use Seed512;
 /// reference source code](http://xoshiro.di.unimi.it/xoshiro512starstar.c) by
 /// David Blackman and Sebastiano Vigna.
 #[derive(Debug, Clone)]
+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]
 pub struct Xoshiro512StarStar {
     s: [u64; 8],
 }
diff --git a/rand_xoshiro/tests/serde.rs b/rand_xoshiro/tests/serde.rs
@@ -0,0 +1,87 @@
+#![cfg(feature="serde1")]
+
+extern crate rand_xoshiro;
+extern crate rand_core;
+#[cfg(all(feature="serde1", test))] extern crate bincode;
+
+use rand_core::{RngCore, SeedableRng};
+use rand_xoshiro::{SplitMix64, Xoroshiro64StarStar, Xoroshiro64Star,
+    Xoroshiro128Plus, Xoroshiro128StarStar, Xoshiro128StarStar, Xoshiro128Plus,
+    Xoshiro256StarStar, Xoshiro256Plus, Xoshiro512StarStar, Xoshiro512Plus};
+
+macro_rules! serde_rng {
+    ($rng:ident) => {
+        use bincode;
+        use std::io::{BufWriter, BufReader};
+
+        let mut rng = $rng::seed_from_u64(0);
+
+        let buf: Vec<u8> = Vec::new();
+        let mut buf = BufWriter::new(buf);
+        bincode::serialize_into(&mut buf, &rng).expect("Could not serialize");
+
+        let buf = buf.into_inner().unwrap();
+        let mut read = BufReader::new(&buf[..]);
+        let mut deserialized: $rng = bincode::deserialize_from(&mut read)
+            .expect("Could not deserialize");
+
+        for _ in 0..16 {
+            assert_eq!(rng.next_u64(), deserialized.next_u64());
+        }
+    }
+}
+
+#[test]
+fn test_splitmix64() {
+    serde_rng!(SplitMix64);
+}
+
+#[test]
+fn test_xoroshiro64starstar() {
+    serde_rng!(Xoroshiro64StarStar);
+}
+
+#[test]
+fn test_xoroshiro64star() {
+    serde_rng!(Xoroshiro64Star);
+}
+
+#[test]
+fn test_xoroshiro128plus() {
+    serde_rng!(Xoroshiro128Plus);
+}
+
+#[test]
+fn test_xoroshiro128starstar() {
+    serde_rng!(Xoroshiro128StarStar);
+}
+
+#[test]
+fn test_xoshiro128starstar() {
+    serde_rng!(Xoshiro128StarStar);
+}
+
+#[test]
+fn test_xoshiro128plus() {
+    serde_rng!(Xoshiro128Plus);
+}
+
+#[test]
+fn test_xoshiro256starstar() {
+    serde_rng!(Xoshiro256StarStar);
+}
+
+#[test]
+fn test_xoshiro256plus() {
+    serde_rng!(Xoshiro256Plus);
+}
+
+#[test]
+fn test_xoshiro512starstar() {
+    serde_rng!(Xoshiro512StarStar);
+}
+
+#[test]
+fn test_xoshiro512plus() {
+    serde_rng!(Xoshiro512Plus);
+}

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ use rand_core::{RngCore, SeedableRng, Error};`
`22`	`22`	/// from [`dsiutils`](http://dsiutils.di.unimi.it/) is used.
`23`	`23`	`#[allow(missing_copy_implementations)]`
`24`	`24`	`#[derive(Debug, Clone)]`
	`25`	`+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]`
`25`	`26`	`pub struct SplitMix64 {`
`26`	`27`	`x: u64,`
`27`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ use rand_core::{SeedableRng, RngCore, Error};`
`20`	`20`	`/// reference source code](http://xoshiro.di.unimi.it/xoshiro128starstar.c) by`
`21`	`21`	`/// David Blackman and Sebastiano Vigna.`
`22`	`22`	`#[derive(Debug, Clone)]`
	`23`	`+#[cfg_attr(feature="serde1", derive(Serialize, Deserialize))]`
`23`	`24`	`pub struct Xoshiro128Plus {`
`24`	`25`	`s: [u32; 4],`
`25`	`26`	`}`