From ce78d2f37b0971c40e7260a69c958ee1bd153a3d Mon Sep 17 00:00:00 2001 From: Diggory Hardy Date: Mon, 9 Jul 2018 18:32:31 +0100 Subject: [PATCH] doc: add policy on project scope --- doc/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 2f8c5572f9..6fdc9c4529 100644 --- a/doc/README.md +++ b/doc/README.md @@ -41,7 +41,26 @@ TODO ### Project Scope -TODO +The `rand_core` library has the following scope: + +- the core traits which RNGs may implement +- tools for implementing these traits + +The `rand` library has the following scope: + +- re-export all parts of `rand_core` applicable to end users +- an interface to request entropy from an external source +- hooks to provide entropy from several platform-specific sources +- traits covering common RNG functionality +- some PRNGs, notably `StdRng` and `SmallRng` +- `thread_rng` auto-seeding source of randomness +- conversion of random bits to common types and uses +- shuffling and sampling from sequences +- sampling from various random number distributions + +Note: the scope of the project and above libraries may change. We are currently +discussing moving PRNGs (#431) and distributions (#290) to other libraries or +projects. ### Code style