summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-03 11:12:29 +0100
committerTyge Løvset <[email protected]>2021-03-03 11:12:29 +0100
commit8e8234e98d5cdfebb8653b93d41cd7ae452fddb4 (patch)
tree8b1a48e20482a2e36a54a0de9f8cf583dff35e50 /docs
parentc89215375b7ff4b863c757b1a5f7817496a6fbc9 (diff)
downloadSTC-modified-8e8234e98d5cdfebb8653b93d41cd7ae452fddb4.tar.gz
STC-modified-8e8234e98d5cdfebb8653b93d41cd7ae452fddb4.zip
Some general doc changes.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md2
-rw-r--r--docs/cbits_api.md2
-rw-r--r--docs/cdeq_api.md2
-rw-r--r--docs/clist_api.md2
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/cpque_api.md2
-rw-r--r--docs/cptr_api.md2
-rw-r--r--docs/cqueue_api.md2
-rw-r--r--docs/crandom_api.md23
-rw-r--r--docs/cset_api.md2
-rw-r--r--docs/csmap_api.md2
-rw-r--r--docs/csset_api.md2
-rw-r--r--docs/cstack_api.md2
-rw-r--r--docs/cstr_api.md2
-rw-r--r--docs/cvec_api.md2
15 files changed, 25 insertions, 26 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index 7dabba41..cdf1bf96 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -18,7 +18,7 @@ be replaced by `i` in all of the following documentation. The `N` character shou
## Header file
-All **carray** definitions and prototypes may be included in your C source file by including a single header file.
+All carray definitions and prototypes are available by including a single header file.
```c
#include "stc/carray.h"
diff --git a/docs/cbits_api.md b/docs/cbits_api.md
index 07f5e072..5443feae 100644
--- a/docs/cbits_api.md
+++ b/docs/cbits_api.md
@@ -9,7 +9,7 @@ for a functional description.
## Header file
-All cstr definitions and prototypes may be included in your C source file by including a single header file.
+All cbits definitions and prototypes are available by including a single header file.
```c
#include "stc/cbits.h"
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 044b7313..065419fb 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -26,7 +26,7 @@ using_cdeq(str, cstr_t, cstr_compare_raw, cstr_del, cstr_from, cstr_c_str, const
## Header file
-All cdeq definitions and prototypes may be included in your C source file by including a single header file.
+All cdeq definitions and prototypes are available by including a single header file.
```c
#include "stc/cdeq.h"
diff --git a/docs/clist_api.md b/docs/clist_api.md
index af71ae19..cbd0bdbf 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -33,7 +33,7 @@ using_clist(str, cstr_t, cstr_compare_raw, cstr_del, cstr_from, cstr_c_str, cons
## Header file
-All clist definitions and prototypes may be included in your C source file by including a single header file.
+All clist definitions and prototypes are available by including a single header file.
```c
#include "stc/clist.h"
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 9b0648b9..841eda93 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -35,7 +35,7 @@ be replaced by `ii` in all of the following documentation.
## Header file
-All cmap definitions and prototypes may be included in your C source file by including a single header file.
+All cmap definitions and prototypes are available by including a single header file.
```c
#include <stc/cmap.h>
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index a4dd4669..7d40b08e 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -20,7 +20,7 @@ Declaring `using_cpque(i, cvec_i, >)`, `X` should be replaced by `i` in the foll
## Header file
-All cpque definitions and prototypes may be included in your C source file by including a single header file.
+All cpque definitions and prototypes are available by including a single header file.
```c
#include "stc/cpque.h"
diff --git a/docs/cptr_api.md b/docs/cptr_api.md
index 66c5797b..4f4da240 100644
--- a/docs/cptr_api.md
+++ b/docs/cptr_api.md
@@ -23,7 +23,7 @@ affect the names of all cptr types and methods. E.g. declaring `using_cptr(v4, V
## Header file
-All cptr definitions and prototypes may be included in your C source file by including a single header file.
+All cptr and csptr definitions and prototypes are available by including a single header file.
```c
#include "stc/cptr.h"
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 6a9aee7f..ef01b2c4 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -16,7 +16,7 @@ a **cdeq_X** or **clist_X** type as underlying implementation, given as `ctype`.
## Header file
-All cqueue definitions and prototypes may be included in your C source file by including a single header file.
+All cqueue definitions and prototypes are available by including a single header file.
```c
#include "stc/cqueue.h" /* includes default underlying implementation header cdeq.h */
diff --git a/docs/crandom_api.md b/docs/crandom_api.md
index 69cc4789..44f89809 100644
--- a/docs/crandom_api.md
+++ b/docs/crandom_api.md
@@ -12,28 +12,19 @@ Weyl-sequence as part of the state. In general testing, **stc64** is the fastest
128-bit state with no minimum period length guarantee. *stc64* does not require fast multiplication
or 128-bit integer operations. It has 256 bit state, but updates only 192 bit per generated number.
-There is no *jump function*, but for each odd number Weyl-increment (state[3]), it starts a new
+There is no *jump function*, but each odd number Weyl-increment (state[3]), starts a new
unique 2^64 *minimum* length period. For a single thread, a minimum period of 2^127 is generated
when the Weyl-increment is incremented by 2 every 2^64 output.
-**stc64** passes *PractRand*, tested up to 8TB output, Vigna's Hamming weight test, and simple
+**stc64** passes *PractRand* (tested up to 8TB output), Vigna's Hamming weight test, and simple
correlation tests, i.e. *n* interleaved streams with only one-bit differences in initial state.
For more, see the PRNG shootout by Vigna: http://prng.di.unimi.it and the debate between the authors of
xoshiro and pcg (Vigna/O'Neill) PRNGs: https://www.pcg-random.org/posts/on-vignas-pcg-critique.html
-## Types
-
-| Name | Type definition | Used to represent... |
-|:-------------------|:------------------------------------------|:-----------------------------|
-| `stc64_t` | `struct {uint64_t state[4];}` | The PRNG engine type |
-| `stc64_uniform_t` | `struct {int64_t lower; uint64_t range;}` | Integer uniform distribution |
-| `stc64_uniformf_t` | `struct {double lower, range;}` | Real number uniform distr. |
-| `stc64_normalf_t` | `struct {double mean, stddev;}` | Normal distribution type |
-
## Header file
-All cstr definitions and prototypes may be included in your C source file by including a single header file.
+All crandom definitions and prototypes are available by including a single header file.
```c
#include "stc/crandom.h"
```
@@ -58,6 +49,14 @@ double stc64_uniformf(stc64_t* rng, stc64_uniformf_t* dist); //
stc64_normalf_t stc64_normalf_init(double mean, double stddev); // normal-distribution
double stc64_normalf(stc64_t* rng, stc64_normalf_t* dist);
```
+## Types
+
+| Name | Type definition | Used to represent... |
+|:-------------------|:------------------------------------------|:-----------------------------|
+| `stc64_t` | `struct {uint64_t state[4];}` | The PRNG engine type |
+| `stc64_uniform_t` | `struct {int64_t lower; uint64_t range;}` | Integer uniform distribution |
+| `stc64_uniformf_t` | `struct {double lower, range;}` | Real number uniform distr. |
+| `stc64_normalf_t` | `struct {double mean, stddev;}` | Normal distribution type |
## Example
```c
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 65061f8f..5629ae07 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -21,7 +21,7 @@ be replaced by `i` in all of the following documentation.
## Header file
-All cset definitions and prototypes may be included in your C source file by including a single header file.
+All cset definitions and prototypes are available by including a single header file.
```c
#include "stc/cset.h"
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 61362588..711d7e6a 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -37,7 +37,7 @@ be replaced by `ii` in all of the following documentation.
## Header file
-All csmap definitions and prototypes may be included in your C source file by including a single header file.
+All csmap definitions and prototypes are available by including a single header file.
```c
#include <stc/csmap.h>
diff --git a/docs/csset_api.md b/docs/csset_api.md
index b6c2acf2..33be5fd3 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -22,7 +22,7 @@ be replaced by `i` in all of the following documentation.
## Header file
-All csset definitions and prototypes may be included in your C source file by including a single header file.
+All csset definitions and prototypes are available by including a single header file.
```c
#include "stc/csset.h"
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 4a8a6f34..c953ef91 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -17,7 +17,7 @@ affect the names of all cstack types and methods. E.g. declaring `using_cstack(i
## Header file
-All cstack definitions and prototypes may be included in your C source file by including a single header file.
+All cstack definitions and prototypes are available by including a single header file.
```c
#include "stc/cstack.h" /* includes default underlying implementation header cvec.h */
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index f14cfc38..9f26187b 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -7,7 +7,7 @@ See the c++ class [std::basic_string](https://en.cppreference.com/w/cpp/string/b
## Header file
-All cstr definitions and prototypes may be included in your C source file by including a single header file.
+All cstr definitions and prototypes are available by including a single header file.
```c
#include "stc/cstr.h"
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 09e73931..bf287f02 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -30,7 +30,7 @@ using_cvec(str, cstr_t, cstr_compare_raw, cstr_del, cstr_from, cstr_c_str, const
## Header file
-All cvec definitions and prototypes may be included in your C source file by including a single header file.
+All cvec definitions and prototypes are available by including a single header file.
```c
#include "stc/cvec.h"