Skip to content

Commit 3682633

Browse files
committed
doc: add policy on project scope
1 parent e5134e8 commit 3682633

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

doc/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,26 @@ TODO
4343

4444
### Project Scope
4545

46-
TODO
46+
The `rand_core` library has the following scope:
47+
48+
- the core traits which RNGs may implement
49+
- tools for implementing these traits
50+
51+
The `rand` library has the following scope:
52+
53+
- re-export all parts of `rand_core` applicable to end users
54+
- an interface to request entropy from an external source
55+
- hooks to provide entropy from several platform-specific sources
56+
- traits covering common RNG functionality
57+
- some PRNGs, notably `StdRng` and `SmallRng`
58+
- `thread_rng` auto-seeding source of randomness
59+
- conversion of random bits to common types and uses
60+
- shuffling and sampling from sequences
61+
- sampling from various random number distributions
62+
63+
Note: the scope of the project and above libraries may change. We are currently
64+
discussing moving PRNGs (#431) and distributions (#290) to other libraries or
65+
projects.
4766

4867
### Code style
4968

0 commit comments

Comments
 (0)