vendor/rand_xorshift/README.md

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