diff options
| author | Tyge Løvset <[email protected]> | 2020-12-03 11:38:40 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2020-12-03 11:38:40 +0100 |
| commit | 0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11 (patch) | |
| tree | f6fa75a63428c2840e50b1c0133b248bc66ce870 /docs/crandom_api.md | |
| parent | 2afda956b19186c6f4306d43429948a6f7f40d07 (diff) | |
| download | STC-modified-0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11.tar.gz STC-modified-0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11.zip | |
More docs fixing.
Diffstat (limited to 'docs/crandom_api.md')
| -rw-r--r-- | docs/crandom_api.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/crandom_api.md b/docs/crandom_api.md index 87bddcef..b645749b 100644 --- a/docs/crandom_api.md +++ b/docs/crandom_api.md @@ -1,11 +1,11 @@ -# Random number generators +# Module crand: Pseudo Random Number Generators -This describes the API of module **crandom**. Contains *pcg32* and a extremely fast *64-bit PRNG* inspired by *sfc64*. -The RNG's can generate uniform and normal distributions. +This describes the API of module **crand**. Contains *pcg32* and an extremely fast *64-bit PRNG* inspired by *sfc64*. +The PRNG's can generate uniform and normal distributions. ## Types -| crandom | Type definition | Used to represent... | +| Name | Type definition | Used to represent... | |:----------------------|:--------------------------------------------|:-------------------------------------| | `crand_rng32_t` | `struct {uint64_t state[2];}` | The crandom type | | `crand_uniform_i32_t` | `struct {int32_t offset; uint32_t range;}` | The crandom element type | |