diff options
Diffstat (limited to 'rand/rand_pcg/README.md')
| -rw-r--r-- | rand/rand_pcg/README.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/rand/rand_pcg/README.md b/rand/rand_pcg/README.md new file mode 100644 index 0000000..4599813 --- /dev/null +++ b/rand/rand_pcg/README.md @@ -0,0 +1,51 @@ +# rand_pcg + +[](https://travis-ci.org/rust-random/rand) +[](https://ci.appveyor.com/project/rust-random/rand) +[](https://crates.io/crates/rand_pcg) +[[](https://rust-random.github.io/book/) +[](https://rust-random.github.io/rand/rand_pcg) +[](https://docs.rs/rand_pcg) +[](https://github.com/rust-random/rand#rust-version-requirements) + +Implements a selection of PCG random number generators. + +> PCG is a family of simple fast space-efficient statistically good algorithms +> for random number generation. [Melissa O'Neill, Harvey Mudd College, 2014]. + +The PCG algorithms are not suitable for cryptographic uses, but perform well +in statistical tests, use little memory and are fairly fast. +See the [pcg-random website](http://www.pcg-random.org/). + +This crate depends on [rand_core](https://crates.io/crates/rand_core) and is +part of the [Rand project](https://github.com/rust-random/rand). + +Links: + +- [API documentation (master)](https://rust-random.github.io/rand/rand_pcg) +- [API documentation (docs.rs)](https://docs.rs/rand_pcg) +- [Changelog](CHANGELOG.md) + + +## Crate Features + +`rand_pcg` is `no_std` compatible. It does not require any functionality +outside of the `core` lib, thus there are no features to configure. + +The `serde1` feature includes implementations of `Serialize` and `Deserialize` +for the included RNGs. NOTE: to use binary serialisation with any of the 64-bit +output (128-bit internal) RNGs, you must add the following dependency, since the +`i128` feature is not current enabled by default (this should be fixed soon): + +``` +bincode = { version = "1", features = ["i128"] } +``` + + +## License + +`rand_pcg` is distributed under the terms of both the MIT license and the +Apache License (Version 2.0). + +See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and +[COPYRIGHT](COPYRIGHT) for details. |