Merge branch 'master' into patch-6

Author: TheIronBorn

.travis.yml

@@ -1,49 +1,118 @@
 language: rust
 sudo: false
 
-# We aim to test all the following in any combination:
-# - standard tests, benches, documentation, all available features
-# - pinned stable, latest stable, beta and nightly Rust releases
-# - Linux, OS X, Android, iOS, bare metal (i.e. no_std)
-# - x86_64, ARMv7, a Big-Endian arch (MIPS)
+# We support too many combinations of Rust releases, crate features, operating
+# systems, and architectures to even remotely test all combinations.
+# Yet it turns out we can test most of these independent of each other, because
+# they serve different goals or test different pieces of code.
+#
+# RUST RELEASES
+# Goal: make sure we don't use language features unavailable on a certain
+#       version, and build without warnings.
+# We have different builders use 4 Rust releases, a pinned stable release,
+# the latest stable, beta and nightly.
+#
+# ARCHITECTURES
+# Goal: test against issues caused by differences in endianness, pointer sizes,
+#       etc.
+# We run tests on 4 different architectures.
+# - x64_84, default on Travis (Linux) and AppVeyor (Windows)
+# - i686, second AppVeyor (Windows) configuration
+# - MIPS, big-endian Linux emulated with QEMU (thanks to Trust)
+# - ARMv7, Android emulated with QEMU (thanks to Trust)
+#
+# OPERATING SYSTEMS
+# Goal: test on many operating systems, to verify the OsRng code, which is
+#       mostly architecture-independent.
+# We run tests on Linux, OS X, Windows, Android (emulated), and Node.js (using
+# cargo-web).
+# One builder cross-compiles for many of the remaining OSes, which ensures we
+# keep building, but doesn't run tests.
+# OSes supported by Rand but which we can't cross-compile because there
+# is no pre-built standard library available: Dragonfly BSD, Haiku, OpenBSD.
+#
+# CRATE FEATURES, TESTS, AND SUB-CRATES
+# Goal: Run unit tests, doctests, examples, and test benchmarks for all crates,
+#       in configurations that cover all interesting combinations of features.
+# (`--lib` only runs unit tests just like `--tests`, but the latter is not
+# available in Rust 1.22.0)
+# Tests run on rand:
+# - test no_std support, but only the unit tests:
+#   `cargo test --lib --no-default-features`
+# - run unit tests and doctests with all features which are available on stable:
+#   `cargo test --features=serde1,log`
+# - test examples:
+#   `cargo test --examples`
+# Additional tests on nightly:
+# - run unit tests and doctests with all features which are available on nightly:
+#   `cargo test --all-features`
+# - test no_std support, including the nightly alloc feature:
+#   cargo test --lib --no-default-features --features=alloc
+# - run benchmarks as tests:
+#   `cargo test --benches --features=nightly`
+# Tests on subcrates:
+#   `cargo test --package rand_core`
+#   `cargo test --package rand_core --features=alloc` (requires nightly)
+#   `cargo test --package rand_core --no-default-features`
+#   `cargo test --package rand_isaac --features=serde1`
+#   `cargo test --package rand_xorshift --features=serde1`
 matrix:
   include:
     - rust: 1.22.0
+      env: DESCRIPTION="pinned stable Rust release"
       install:
       script:
-        # TODO: use --tests instead of --lib on more recent compiler
         - cargo test --lib --no-default-features
+        - cargo test --features=serde1,log
+        - cargo test --examples
+        - cargo test --package rand_core
         - cargo test --package rand_core --no-default-features
-        - cargo test --package rand_isaac --features serde1
-        - cargo test --package rand_xorshift --features serde1
-        - cargo test --features serde1,log
+        - cargo test --package rand_isaac --features=serde1
+        # - cargo test --package rand_xorshift --features=serde1
+
     - rust: stable
+      env: DESCRIPTION="stable Rust release, macOS, iOS (cross-compile only)"
       os: osx
       install:
+        - rustup target add aarch64-apple-ios
       script:
-        - cargo test --tests --no-default-features
+        - cargo test --lib --no-default-features
+        - cargo test --features=serde1,log,i128_support
+        - cargo test --examples
+        - cargo test --package rand_core
         - cargo test --package rand_core --no-default-features
-        - cargo test --package rand_isaac --features serde1
-        - cargo test --package rand_xorshift --features serde1
-        - cargo test --features serde1,log
+        - cargo test --package rand_isaac --features=serde1
+        - cargo test --package rand_xorshift --features=serde1
+        - cargo build --target=aarch64-apple-ios
+
     - rust: beta
+      env: DESCRIPTION="beta Rust release"
       install:
       script:
-        - cargo test --tests --no-default-features
+        - cargo test --lib --no-default-features
+        - cargo test --features=serde1,log,i128_support
+        - cargo test --examples
+        - cargo test --package rand_core
         - cargo test --package rand_core --no-default-features
-        - cargo test --package rand_isaac --features serde1
-        - cargo test --package rand_xorshift --features serde1
-        - cargo test --features serde1,log
+        - cargo test --package rand_isaac --features=serde1
+        - cargo test --package rand_xorshift --features=serde1
+
     - rust: nightly
+      env: DESCRIPTION="nightly features, benchmarks, documentation"
       install:
         - cargo --list | egrep "^\s*deadlinks$" -q || cargo install cargo-deadlinks
+        - cargo deadlinks -V
       before_script:
         - pip install 'travis-cargo<0.2' --user && export PATH=$HOME/.local/bin:$PATH
       script:
-        - cargo test --tests --no-default-features --features=alloc
-        - cargo test --package rand_core --no-default-features --features=alloc,serde1
-        - cargo test --features serde1,log,nightly,alloc
-        - cargo test --all --benches
+        - cargo test --lib --no-default-features --features=alloc
+        - cargo test --all-features
+        - cargo test --benches --features=nightly
+        - cargo test --examples
+        - cargo test --package rand_core
+        - cargo test --package rand_core --no-default-features --features=alloc
+        - cargo test --package rand_isaac --features=serde1
+        # - cargo test --package rand_xorshift --features=serde1
         # remove cached documentation, otherwise files from previous PRs can get included
         - rm -rf target/doc
         - cargo doc --no-deps --all --all-features
@@ -52,52 +121,54 @@ matrix:
         - travis-cargo --only nightly doc-upload
 
     - rust: nightly
+      env: DESCRIPTION="WASM via emscripten, stdweb and wasm-bindgen"
       install:
         - rustup target add wasm32-unknown-unknown
-        # Use cargo-update since we need a real update-or-install command
-        # Only install if not already installed:
-        #- cargo --list | egrep "\binstall-update$" -q || cargo install cargo-update
-        #- cargo install-update -i cargo-web
-        # Cargo has errors with sub-commands so ignore updating for now:
+        - rustup target add wasm32-unknown-emscripten
+        # cargo-web takes ±10 min. to install, and cargo and cargo-update offer
+        # no reliable update-or-install command. We ignore updating for now
+        # (just drop the Travis' caches when necessary)
         - cargo --list | egrep "^\s*web$" -q || cargo install cargo-web
+        - cargo web -V
+      addons:
+        chrome: stable
       script:
-        - cargo web test --target wasm32-unknown-unknown --nodejs --features=stdweb
-
-    - rust: nightly
-      install:
-        - rustup target add wasm32-unknown-unknown
-      script:
-        - cargo build --target wasm32-unknown-unknown --features wasm-bindgen
+        # testing wasm32-unknown-emscripten fails because of rust-lang/rust#49877
+        - cargo build --target wasm32-unknown-emscripten
+        #- cargo web test --target wasm32-unknown-emscripten
+        #- cargo web test --nodejs --target wasm32-unknown-emscripten
+        - cargo build --target wasm32-unknown-unknown # without any features
+        - cargo web test --nodejs --target wasm32-unknown-unknown --features=stdweb
+        - cargo build --target wasm32-unknown-unknown --features=wasm-bindgen
 
     - rust: nightly
+      env: DESCRIPTION="cross-platform builder (doesn't run tests)"
       install:
-        - rustup target add thumbv6m-none-eabi
+        - rustup target add x86_64-sun-solaris
+        - rustup target add x86_64-unknown-cloudabi
+        - rustup target add x86_64-unknown-freebsd
+        #- rustup target add x86_64-unknown-fuchsia
+        - rustup target add x86_64-unknown-netbsd
+        - rustup target add x86_64-unknown-redox
       script:
-        # Bare metal target; no std; only works on nightly
-        - cargo build --no-default-features --target thumbv6m-none-eabi --release
+        - cargo build --target=x86_64-sun-solaris --all-features
+        - cargo build --target=x86_64-unknown-cloudabi --all-features
+        - cargo build --target=x86_64-unknown-freebsd --all-features
+        #- cargo build --target=x86_64-unknown-fuchsia --all-features
+        - cargo build --target=x86_64-unknown-netbsd --all-features
+        - cargo build --target=x86_64-unknown-redox --all-features
 
     # Trust cross-built/emulated targets. We must repeat all non-default values.
     - rust: stable
       sudo: required
       dist: trusty
       services: docker
-      env: TARGET=x86_64-unknown-freebsd DISABLE_TESTS=1
+      env: DESCRIPTION="Linux (MIPS, big-endian)" TARGET=mips-unknown-linux-gnu
     - rust: stable
       sudo: required
       dist: trusty
       services: docker
-      env: TARGET=mips-unknown-linux-gnu
-    - rust: stable
-      sudo: required
-      dist: trusty
-      services: docker
-      env: TARGET=armv7-linux-androideabi DISABLE_TESTS=1
-    - rust: stable
-      os: osx
-      sudo: required
-      dist: trusty
-      services: docker
-      env: TARGET=armv7-apple-ios DISABLE_TESTS=1
+      env: DESCRIPTION="Android (ARMv7)" TARGET=armv7-linux-androideabi
 
 before_install:
   - set -e

CHANGELOG.md

@@ -8,6 +8,29 @@ A [separate changelog is kept for rand_core](rand_core/CHANGELOG.md).
 
 You may also find the [Update Guide](UPDATING.md) useful.
 
+## [0.6.0] - Unreleased
+
+### Crate features and organisation
+- The ISAAC and Xorshift RNGs have been moved to their own crates: `rand_isaac`
+  and `rand_xorshift`. (#551, #557)
+- `Uniform` supports inclusive ranges: `Uniform::from(a..=b)`. This is
+  automatically enabled for Rust >= 1.27. (#566)
+- Support for `i128` and `u128` is automatically enabled for Rust >= 1.26. This
+  renders the `i128_support` feature obsolete. It still exists for backwards
+  compatibility but does not have any effect. This breaks programs using Rand
+  with `i128_support` on nightlies older than Rust 1.26. (#571)
+
+### New distributions
+- Added sampling from the unit sphere and circle. (#567)
+
+### Sequences module
+- Optimised and changed return type of the `sample_indices` function. (#479)
+- Added weighted sampling. (#518)
+
+### Platform support
+- Added support for wasm-bindgen. (#541)
+- Added basic SIMD support. (#523)
+
 ## [0.5.4] - 2018-07-11
 ### Platform support
 - Make `OsRng` work via WASM/stdweb for WebWorkers

Cargo.toml

@@ -20,10 +20,10 @@ appveyor = { repository = "alexcrichton/rand" }
 
 [features]
 default = ["std" ] # without "std" rand uses libcore
-nightly = ["i128_support", "simd_support"] # enables all features requiring nightly rust
+nightly = ["simd_support"] # enables all features requiring nightly rust
 std = ["rand_core/std", "alloc", "libc", "winapi", "cloudabi", "fuchsia-zircon"]
 alloc = ["rand_core/alloc"]  # enables Vec and Box support (without std)
-i128_support = [] # enables i128 and u128 support
+i128_support = [] # dummy feature for backwards compatibility
 simd_support = ["packed_simd"] # enables SIMD support
 serde1 = ["rand_core/serde1", "rand_isaac/serde1", "rand_xorshift/serde1"] # enables serialization for PRNGs
 

README.md

@@ -115,9 +115,8 @@ Rand is built with only the `std` feature enabled by default. The following
 optional features are available:
 
 - `alloc` can be used instead of `std` to provide `Vec` and `Box`.
-- `i128_support` enables support for generating `u128` and `i128` values.
 - `log` enables some logging via the `log` crate.
-- `nightly` enables all unstable features (`i128_support`, `simd_support`).
+- `nightly` enables all unstable features (`simd_support`).
 - `serde1` enables serialization for some types, via Serde version 1.
 - `simd_support` enables uniform sampling of SIMD types (integers and floats).
 - `stdweb` enables support for `OsRng` on `wasm32-unknown-unknown` via `stdweb`

appveyor.yml

@@ -32,8 +32,11 @@ install:
 build: false
 
 test_script:
-  - cargo test --all # cannot use --all and --features together
-  - cargo test --all --benches
-  - cargo test --features serde1,log,nightly
-  - cargo test --tests --no-default-features --features=alloc,serde1
-  - cargo test --package rand_core --no-default-features --features=alloc,serde1
+  - cargo test --lib --no-default-features --features alloc
+  - cargo test --all-features
+  - cargo test --benches --features=nightly
+  - cargo test --examples
+  - cargo test --package rand_core
+  - cargo test --package rand_core --no-default-features --features=alloc
+  - cargo test --package rand_isaac --features=serde1
+  - cargo test --package rand_xorshift --features=serde1

benches/seq.rs

@@ -1,4 +1,5 @@
 #![feature(test)]
+#![allow(non_snake_case)]
 
 extern crate test;
 extern crate rand;
@@ -27,28 +28,31 @@ fn seq_slice_choose_1_of_1000(b: &mut Bencher) {
     })
 }
 
-#[bench]
-fn seq_slice_choose_multiple_1_of_1000(b: &mut Bencher) {
-    let mut rng = SmallRng::from_rng(thread_rng()).unwrap();
-    let x : &[usize] = &[1; 1000];
-    b.iter(|| {
-        x.choose_multiple(&mut rng, 1).cloned().next()
-    })
-}
-
-#[bench]
-fn seq_slice_choose_multiple_10_of_100(b: &mut Bencher) {
-    let mut rng = SmallRng::from_rng(thread_rng()).unwrap();
-    let x : &[usize] = &[1; 100];
-    let mut buf = [0; 10];
-    b.iter(|| {
-        for (v, slot) in x.choose_multiple(&mut rng, buf.len()).zip(buf.iter_mut()) {
-            *slot = *v;
+macro_rules! seq_slice_choose_multiple {
+    ($name:ident, $amount:expr, $length:expr) => {
+        #[bench]
+        fn $name(b: &mut Bencher) {
+            let mut rng = SmallRng::from_rng(thread_rng()).unwrap();
+            let x : &[i32] = &[$amount; $length];
+            let mut result = [0i32; $amount];
+            b.iter(|| {
+                // Collect full result to prevent unwanted shortcuts getting
+                // first element (in case sample_indices returns an iterator).
+                for (slot, sample) in result.iter_mut().zip(
+                    x.choose_multiple(&mut rng, $amount)) {
+                    *slot = *sample;
+                }
+                result[$amount-1]
+            })
         }
-        buf
-    })
+    }
 }
 
+seq_slice_choose_multiple!(seq_slice_choose_multiple_1_of_1000, 1, 1000);
+seq_slice_choose_multiple!(seq_slice_choose_multiple_950_of_1000, 950, 1000);
+seq_slice_choose_multiple!(seq_slice_choose_multiple_10_of_100, 10, 100);
+seq_slice_choose_multiple!(seq_slice_choose_multiple_90_of_100, 90, 100);
+
 #[bench]
 fn seq_iter_choose_from_100(b: &mut Bencher) {
     let mut rng = SmallRng::from_rng(thread_rng()).unwrap();
@@ -78,17 +82,22 @@ fn seq_iter_choose_multiple_fill_10_of_100(b: &mut Bencher) {
 }
 
 macro_rules! sample_indices {
-    ($name:ident, $amount:expr, $length:expr) => {
+    ($name:ident, $fn:ident, $amount:expr, $length:expr) => {
         #[bench]
         fn $name(b: &mut Bencher) {
             let mut rng = SmallRng::from_rng(thread_rng()).unwrap();
             b.iter(|| {
-                sample_indices(&mut rng, $length, $amount)
+                index::$fn(&mut rng, $length, $amount)
             })
         }
     }
 }
 
-sample_indices!(seq_sample_indices_10_of_1k, 10, 1000);
-sample_indices!(seq_sample_indices_50_of_1k, 50, 1000);
-sample_indices!(seq_sample_indices_100_of_1k, 100, 1000);
+sample_indices!(misc_sample_indices_1_of_1k, sample, 1, 1000);
+sample_indices!(misc_sample_indices_10_of_1k, sample, 10, 1000);
+sample_indices!(misc_sample_indices_100_of_1k, sample, 100, 1000);
+sample_indices!(misc_sample_indices_100_of_1M, sample, 100, 1000_000);
+sample_indices!(misc_sample_indices_100_of_1G, sample, 100, 1000_000_000);
+sample_indices!(misc_sample_indices_200_of_1G, sample, 200, 1000_000_000);
+sample_indices!(misc_sample_indices_400_of_1G, sample, 400, 1000_000_000);
+sample_indices!(misc_sample_indices_600_of_1G, sample, 600, 1000_000_000);

build.rs

@@ -2,6 +2,9 @@ extern crate rustc_version;
 use rustc_version::{version, Version};
 
 fn main() {
+    if version().unwrap() >= Version::parse("1.26.0").unwrap() {
+        println!("cargo:rustc-cfg=rust_1_26");
+    }
     if version().unwrap() >= Version::parse("1.27.0").unwrap() {
         println!("cargo:rustc-cfg=rust_1_27");
     }