vendor/rand_xorshift-0.1.0/README.md

   1 # rand_xorshift
   2
   3 [![Build Status](https://travis-ci.org/rust-random/small-rngs.svg)](https://travis-ci.org/rust-random/small-rngs)
   4 [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/small-rngs?svg=true)](https://ci.appveyor.com/project/rust-random/small-rngs)
   5 [![Latest version](https://img.shields.io/crates/v/rand_xorshift.svg)](https://crates.io/crates/rand_xorshift)
   6 [![Documentation](https://docs.rs/rand_xorshift/badge.svg)](https://docs.rs/rand_xorshift)
   7 [![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-yellow.svg)](https://github.com/rust-random/rand#rust-version-requirements)
   8 [![License](https://img.shields.io/crates/l/rand_xorshift.svg)](https://github.com/rust-random/small-rngs/tree/master/rand_xorshift#license)
   9
  10 Implements the Xorshift random number generator.
  11
  12 The Xorshift[^1] algorithm is not suitable for cryptographic purposes
  13 but is very fast. If you do not know for sure that it fits your
  14 requirements, use a more secure one such as `StdRng` or `OsRng`.
  15
  16 [^1]: Marsaglia, George (July 2003).
  17       ["Xorshift RNGs"](https://www.jstatsoft.org/v08/i14/paper).
  18       *Journal of Statistical Software*. Vol. 8 (Issue 14).
  19
  20 Documentation:
  21 [master branch](https://rust-random.github.io/small-rngs/rand_xorshift/index.html),
  22 [by release](https://docs.rs/rand_xorshift)
  23
  24 [Changelog](CHANGELOG.md)
  25
  26 [rand]: https://crates.io/crates/rand
  27
  28
  29 ## Crate Features
  30
  31 `rand_xorshift` is `no_std` compatible. It does not require any functionality
  32 outside of the `core` lib, thus there are no features to configure.
  33
  34 The `serde1` feature includes implementations of `Serialize` and `Deserialize`
  35 for the included RNGs.
  36
  37
  38 ## License
  39
  40 `rand_xorshift` is distributed under the terms of both the MIT license and the
  41 Apache License (Version 2.0).
  42
  43 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and
  44 [COPYRIGHT](COPYRIGHT) for details.