summaryrefslogtreecommitdiffhomepage
path: root/docs/crandom_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-21 11:25:31 +0100
committerTyge Løvset <[email protected]>2021-01-21 11:25:31 +0100
commitff84705c03e06ad2f44396719253fe0fb8112171 (patch)
tree10e34d73a00a7ddb75dffb0b34b2ba1ab0c720b1 /docs/crandom_api.md
parent396dc5b30de95776a745be18c33ef207f0bb6f49 (diff)
downloadSTC-modified-ff84705c03e06ad2f44396719253fe0fb8112171.tar.gz
STC-modified-ff84705c03e06ad2f44396719253fe0fb8112171.zip
Updated docs.
Diffstat (limited to 'docs/crandom_api.md')
-rw-r--r--docs/crandom_api.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/crandom_api.md b/docs/crandom_api.md
index c8ad34ff..1e93c4af 100644
--- a/docs/crandom_api.md
+++ b/docs/crandom_api.md
@@ -1,11 +1,12 @@
-# STC Module [crandom](../stc/crandom.h): Pseudo Random Number Generators
+# STC [crandom](../stc/crandom.h): Pseudo Random Number Generator
![Random](pics/random.jpg)
-This describes the API of module **crandom**. It contains **stc64**, a *64-bit PRNG*, and can generate
-bounded uniform and normal distributed random numbers. See [random](https://en.cppreference.com/w/cpp/header/random)
-for similar c++ functionality.
+This describes the API of module **crandom**. It features a *64-bit PRNG* named **stc64**,
+and can generate bounded uniform and normal distributed random numbers.
-**stc64** is an extremely fast PRNG by Tyge Løvset, suited for parallel usage. It features a
+See [random](https://en.cppreference.com/w/cpp/header/random) for similar c++ functionality.
+
+**stc64** is a novel, extremely fast PRNG by Tyge Løvset, suited for parallel usage. It features a
Weyl-sequence as part of the state. It is faster than *sfc64*, *wyhash64*, *pcg64*, and *xoshiro256\*\**
on common platforms. It does not require fast multiplication or 128-bit integer operations. It has a
256 bit state, but updates only 192 bit per generated number.