Many performance optimisations thanks to contributions from the wide
user-base
Rand is not:
Small (LoC). Most low-level crates are small, but the higher-level rand
and rand_distr each contain a lot of functionality.
Simple (implementation). We have a strong focus on correctness, speed and flexibility, but
not simplicity. If you prefer a small-and-simple library, there are
alternatives including fastrand
and oorandom.
Primarily a cryptographic library. rand does provide some generators which
aim to support unpredictable value generation under certain constraints;
see SECURITY.md for details.
Users are expected to determine for themselves
whether rand‘s functionality meets their own security requirements.
Rand is mature (suitable for general usage, with infrequent breaking releases
which minimise breakage) but not yet at 1.0. Current MAJOR.MINOR versions are:
Rand is built with these features enabled by default:
std enables functionality dependent on the std lib
alloc (implied by std) enables functionality requiring an allocator; a
significant portion of sequence and distribution functionality requires this
sys_rng enables rand::rngs::SysRng (uses the getrandom crate)
std_rng enables rand::rngs::StdRng (uses the chacha20 crate)
thread_rng (implies std, std_rng, sys_rng) enables rand::rngs::ThreadRng and rand::rng()
Optionally, the following dependencies can be enabled:
chacha enables rand::rngs::{ChaCha8Rng, ChaCha12Rng, ChaCha20Rng} (uses the chacha20 crate)
Additionally, these features configure Rand:
simd_support (experimental) enables sampling of SIMD values (uniformly
random SIMD integers and floats). Since std::simd is not yet stable this
feature requires nightly Rust and may cause build failures.
unbiased use unbiased sampling for algorithms supporting this option: Uniform distribution.
(By default, bias affecting no more than one in 2^48 samples is accepted.)
Note: enabling this option is expected to affect reproducibility of results.
Portability
Reproducibility
Achieving reproducible results requires not only deterministic algorithms with fixed inputs but also a commitment to stability of algorithms and some platform-specific considerations. A subset of rand does aim to support reproducibility; read more about this in the book: Portability.
WebAssembly support
The WASI and Emscripten
targets are directly supported. The wasm32-unknown-unknown target is not
automatically supported. To enable support for this target, refer to the
getrandom documentation for WebAssembly.
Alternatively, the sys_rng feature may be disabled.
License
Rand is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).
Rand
Rand is a set of crates supporting (pseudo-)random generators:
rand_core::RngCorerand::rngs, and more RNGs:chacha20,rand_xoshiro,rand_pcg,rand_sfc,rand_seeder, rngs reporand::rngis an asymptotically-fast, automatically-seeded and reasonably strong generator available on allstdtargetsWith broad support for random value generation and random processes:
StandardUniformrandom value sampling,Uniform-ranged value sampling and morerand_distrand via thestatrsrand::seqtraitsAll with:
#[no_std]compatibility (partial)Rand is not:
randandrand_distreach contain a lot of functionality.randdoes provide some generators which aim to support unpredictable value generation under certain constraints; see SECURITY.md for details. Users are expected to determine for themselves whetherrand‘s functionality meets their own security requirements.Documentation:
Versions
Rand is mature (suitable for general usage, with infrequent breaking releases which minimise breakage) but not yet at 1.0. Current
MAJOR.MINORversions are:See the CHANGELOG or Upgrade Guide for more details.
Crate Features
Rand is built with these features enabled by default:
stdenables functionality dependent on thestdliballoc(implied bystd) enables functionality requiring an allocator; a significant portion of sequence and distribution functionality requires thissys_rngenablesrand::rngs::SysRng(uses the getrandom crate)std_rngenablesrand::rngs::StdRng(uses the chacha20 crate)thread_rng(impliesstd,std_rng,sys_rng) enablesrand::rngs::ThreadRngandrand::rng()Optionally, the following dependencies can be enabled:
chachaenablesrand::rngs::{ChaCha8Rng, ChaCha12Rng, ChaCha20Rng}(uses the chacha20 crate)Additionally, these features configure Rand:
simd_support(experimental) enables sampling of SIMD values (uniformly random SIMD integers and floats). Sincestd::simdis not yet stable this feature requires nightly Rust and may cause build failures.unbiaseduse unbiased sampling for algorithms supporting this option: Uniform distribution.(By default, bias affecting no more than one in 2^48 samples is accepted.)
Note: enabling this option is expected to affect reproducibility of results.
Portability
Reproducibility
Achieving reproducible results requires not only deterministic algorithms with fixed inputs but also a commitment to stability of algorithms and some platform-specific considerations. A subset of
randdoes aim to support reproducibility; read more about this in the book: Portability.WebAssembly support
The WASI and Emscripten targets are directly supported. The
wasm32-unknown-unknowntarget is not automatically supported. To enable support for this target, refer to thegetrandomdocumentation for WebAssembly. Alternatively, thesys_rngfeature may be disabled.License
Rand is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT, and COPYRIGHT for details.