internal/PRNG

Collection of pseudo-random number generators

The algorithms deliver deterministic statistical randomness, not cryptographic randomness.

Algorithm 1: 128-bit Seiran PRNG See: https://github.com/andanteyk/prng-seiran

Algorithm 2: SFC64 and SFC32 (Chris Doty-Humphrey’s Small Fast Chaotic PRNG) See: https://numpy.org/doc/stable/reference/random/bit_generators/sfc64.html

Copyright: 2023 MR Research AG Main author: react0r-com Contributors: Timo Hanke (timohanke)

class SFC64(
  p : Nat64,
  q : Nat64,
  r : Nat64
)

public func init(seed : Nat64)

Initializes the PRNG state with a particular seed

Example: ```motoko

public func initPre()

Initializes the PRNG state with a hardcoded seed. No argument is required.

Example:

public func init3(
  seed1 : Nat64,
  seed2 : Nat64,
  seed3 : Nat64
)

Initializes the PRNG state with three state variables

Example:

public func next() : Nat64

Returns one output and advances the PRNG's state

Example:

Constructs an SFC 64-bit generator. The recommended constructor arguments are: 24, 11, 3.

Example:

import Prng "mo:prng";
let rng = Prng.SFC64(24, 11, 3);

For convenience, the function SFC64a() returns a generator constructed with the recommended parameter set (24, 11, 3).

public func sfc64a() : SFC64

SFC64a is the same as numpy. See: sfc64_next()