]> git.proxmox.com Git - rustc.git/blame - vendor/rand_pcg/README.md
New upstream version 1.61.0+dfsg1
[rustc.git] / vendor / rand_pcg / README.md
CommitLineData
0731742a
XL
1# rand_pcg
2
f035d41b
XL
3[![Build Status](https://travis-ci.org/rust-random/rand.svg?branch=master)](https://travis-ci.org/rust-random/rand)
4[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/rust-random/rand)
0731742a 5[![Latest version](https://img.shields.io/crates/v/rand_pcg.svg)](https://crates.io/crates/rand_pcg)
f035d41b
XL
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_pcg)
8[![API](https://docs.rs/rand_pcg/badge.svg)](https://docs.rs/rand_pcg)
9[![Minimum rustc version](https://img.shields.io/badge/rustc-1.32+-lightgray.svg)](https://github.com/rust-random/rand#rust-version-requirements)
0731742a
XL
10
11Implements a selection of PCG random number generators.
12
13> PCG is a family of simple fast space-efficient statistically good algorithms
14> for random number generation. [Melissa O'Neill, Harvey Mudd College, 2014].
15
16The PCG algorithms are not suitable for cryptographic uses, but perform well
17in statistical tests, use little memory and are fairly fast.
18See the [pcg-random website](http://www.pcg-random.org/).
19
20This crate depends on [rand_core](https://crates.io/crates/rand_core) and is
21part of the [Rand project](https://github.com/rust-random/rand).
22
f035d41b 23Links:
0731742a 24
f035d41b
XL
25- [API documentation (master)](https://rust-random.github.io/rand/rand_pcg)
26- [API documentation (docs.rs)](https://docs.rs/rand_pcg)
27- [Changelog](https://github.com/rust-random/rand/blob/master/rand_pcg/CHANGELOG.md)
0731742a
XL
28
29
30## Crate Features
31
f035d41b 32`rand_pcg` is `no_std` compatible by default.
0731742a
XL
33
34The `serde1` feature includes implementations of `Serialize` and `Deserialize`
35for the included RNGs.
36
0731742a
XL
37## License
38
39`rand_pcg` is distributed under the terms of both the MIT license and the
40Apache License (Version 2.0).
41
42See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT), and
43[COPYRIGHT](COPYRIGHT) for details.