Example changes. Added crand.h possible replacement for crandom.h

1 files changed, 194 insertions, 0 deletions

diff --git a/include/stc/crand.h b/include/stc/crand.h
new file mode 100644
index 00000000..4ebc402d
--- /dev/null
+++ b/include/stc/crand.h
@@ -0,0 +1,194 @@
+/* MIT License
+ *
+ * Copyright (c) 2023 Tyge Løvset
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+#include "ccommon.h"
+
+#ifndef CRAND_H_INCLUDED
+#define CRAND_H_INCLUDED
+/*
+// crand: Pseudo-random number generator
+#include "stc/crand.h"
+
+int main() {
+    uint64_t seed = 123456789;
+    crand_t rng = crand_from(seed);
+    crand_unif_t dist1 = crand_unif_from(1, 6);
+    crandf_unif_t dist2 = crandf_unif_from(1.0, 10.0);
+    crandf_norm_t dist3 = crandf_norm_from(1.0, 10.0);
+
+    uint64_t i = crand_r(&rng);
+    int64_t iu = crand_unif(&rng, &dist1);
+    double xu = crandf_unif(&rng, &dist2);
+    double xn = crandf_norm(&rng, &dist3);
+}
+*/
+#include <string.h>
+#include <math.h>
+
+typedef struct crand { uint64_t state[5]; } crand_t;
+typedef struct crand_unif { int64_t lower; uint64_t range, threshold; } crand_unif_t;
+typedef struct crandf_unif { double lower, range; } crandf_unif_t;
+typedef struct crandf_norm { double mean, stddev, next; int has_next; } crandf_norm_t;
+
+/* PRNG crand_t.
+ * Very fast PRNG suited for parallel usage with Weyl-sequence parameter.
+ * 320-bit state, 256 bit is mutable.
+ * Noticable faster than xoshiro and pcg, slighly slower than wyrand64 and
+ * Romu, but these have restricted capacity for larger parallel jobs or unknown minimum periods.
+ * crand_t supports 2^63 unique threads with a minimum 2^64 period lengths each.
+ * Passes all statistical tests, e.g PractRand and correlation tests, i.e. interleaved
+ * streams with one-bit diff state. Even the 16-bit version (LR=6, RS=5, LS=3) passes
+ * PractRand to multiple TB input.
+ */
+
+/* Global crand_t PRNGs */
+STC_API void     csrand(uint64_t seed);
+STC_API uint64_t crand(void);
+STC_API double   crandf(void);
+
+/* Init crand_t prng with a seed */
+STC_API crand_t crand_from(uint64_t seed);
+
+/* Unbiased bounded uniform distribution. range [low, high] */
+STC_API crand_unif_t crand_unif_from(int64_t low, int64_t high);
+STC_API int64_t crand_unif(crand_t* rng, crand_unif_t* dist);
+
+/* Normal distribution PRNG */
+STC_API double crandf_norm(crand_t* rng, crandf_norm_t* dist);
+
+
+/* Main crand_t prng */
+STC_INLINE uint64_t crand_r(crand_t* rng) {
+    enum {LR=24, RS=11, LS=3}; uint64_t *s = rng->state;
+    const uint64_t out = (s[0] ^ (s[3] += s[4])) + s[1];
+    s[0] = s[1] ^ (s[1] >> RS);
+    s[1] = s[2] + (s[2] << LS);
+    s[2] = ((s[2] << LR) | (s[2] >> (64 - LR))) + out;
+    return out;
+}
+
+/* Float64 random number in range [0.0, 1.0). */
+STC_INLINE double crandf_r(crand_t* rng) {
+    union {uint64_t i; double f;} u = {0x3FF0000000000000U | (crand_r(rng) >> 12)};
+    return u.f - 1.0;
+}
+
+/* Float64 uniform distributed RNG, range [low, high). */
+STC_INLINE double crandf_unif(crand_t* rng, crandf_unif_t* dist) {
+    return crandf_r(rng)*dist->range + dist->lower;
+}
+
+/* Init uniform distributed float64 RNG, range [low, high). */
+STC_INLINE crandf_unif_t crandf_unif_from(double low, double high) {
+    return c_LITERAL(crandf_unif_t){low, high - low};
+}
+
+/* Marsaglia polar method for gaussian/normal distribution, float64. */
+STC_INLINE crandf_norm_t crandf_norm_from(double mean, double stddev) {
+    return c_LITERAL(crandf_norm_t){mean, stddev, 0.0, 0};
+}
+
+/* -------------------------- IMPLEMENTATION ------------------------- */
+#if defined(i_implement)
+
+/* Global random() */
+static crand_t crand_global = {{
+    0x26aa069ea2fb1a4d, 0x70c72c95cd592d04,
+    0x504f333d3aa0b359, 0x9e3779b97f4a7c15,
+    0x6a09e667a754166b
+}};
+
+STC_DEF void csrand(uint64_t seed) {
+    crand_global = crand_from(seed);
+}
+
+STC_DEF uint64_t crand(void) {
+    return crand_r(&crand_global);
+}
+
+STC_DEF double crandf(void) {
+    return crandf_r(&crand_global);
+}
+
+/* rng.state[4] must be odd */
+STC_DEF crand_t crand_from(uint64_t seed) {
+    crand_t rng = {{seed + 0x26aa069ea2fb1a4d,
+                    seed*0x9e3779b97f4a7c15 + 0x70c72c95cd592d04,
+                    seed + 0x504f333d3aa0b359,
+                    seed*0x6a09e667a754166b, seed<<1 | 1}};
+    return rng;
+}
+
+/* Init unbiased uniform uint RNG with bounds [low, high] */
+STC_DEF crand_unif_t crand_unif_from(int64_t low, int64_t high) {
+    crand_unif_t dist = {low, (uint64_t) (high - low + 1)};
+    dist.threshold = (uint64_t)(0 - dist.range) % dist.range;
+    return dist;
+}
+
+#if defined(__SIZEOF_INT128__)
+    #define c_umul128(a, b, lo, hi) \
+        do { __uint128_t _z = (__uint128_t)(a)*(b); \
+             *(lo) = (uint64_t)_z, *(hi) = (uint64_t)(_z >> 64U); } while(0)
+#elif defined(_MSC_VER) && defined(_WIN64)
+    #include <intrin.h>
+    #define c_umul128(a, b, lo, hi) ((void)(*(lo) = _umul128(a, b, hi)))
+#elif defined(__x86_64__)
+    #define c_umul128(a, b, lo, hi) \
+        asm("mulq %3" : "=a"(*(lo)), "=d"(*(hi)) : "a"(a), "rm"(b))
+#endif
+
+/* Int uniform distributed RNG, range [low, high]. */
+STC_DEF int64_t crand_unif(crand_t* rng, crand_unif_t* d) {
+#ifdef c_umul128
+    uint64_t lo, hi;
+    do { c_umul128(crand_r(rng), d->range, &lo, &hi); } while (lo < d->threshold);
+    return d->lower + (int64_t)hi;
+#else
+    uint64_t x, r;
+    do { x = crand_r(rng); r = x % d->range; } while (x - r > -d->range);
+    return d->lower + r;
+#endif
+}
+
+/* Normal distribution PRNG */
+STC_DEF double crandf_norm(crand_t* rng, crandf_norm_t* dist) {
+    double u1, u2, s, m;
+    if (dist->has_next++ & 1)
+        return dist->next * dist->stddev + dist->mean;
+    do {
+        u1 = 2.0 * crandf_r(rng) - 1.0;
+        u2 = 2.0 * crandf_r(rng) - 1.0;
+        s = u1*u1 + u2*u2;
+    } while (s >= 1.0 || s == 0.0);
+    m = sqrt(-2.0 * log(s) / s);
+    dist->next = u2 * m;
+    return (u1 * m) * dist->stddev + dist->mean;
+}
+
+#endif
+#endif
+#undef i_opt
+#undef i_static
+#undef i_header
+#undef i_implement
+#undef i_extern