package core_kernel

  1. Overview
  2. Docs
package core_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

A splittable pseudo-random number generator (SPRNG) functions like a PRNG in that it can be used as a stream of random values; it can also be "split" to produce a second, independent stream of random values. This module implements a splittable pseudo-random number generator that sacrifices cryptographic-quality randomness in favor of performance.

The primary difference between Splittable_random and Random is the State.split operation for generating new pseudo-random states. While it is easy to simulate State.split using Random, the result has undesirable statistical properties; the new state does not behave independently of the original. It is better to switch to Splittable_random if you need an operation like State.split, as this module has been implemented with the statistical properties of splitting in mind. For most other purposes, Random is likely a better choice, as its implementation passes all Diehard tests, while Splittable_random fails some Diehard tests.

module State : sig ... end
val bool : State.t -> Base.Bool.t

Produces a random, fair boolean.

val int : State.t -> lo:Base.Int.t -> hi:Base.Int.t -> Base.Int.t

Produce a random number uniformly distributed in the given inclusive range. (In the case of float, hi may or may not be attainable, depending on rounding.)

val int32 : State.t -> lo:Base.Int32.t -> hi:Base.Int32.t -> Base.Int32.t
val int64 : State.t -> lo:Base.Int64.t -> hi:Base.Int64.t -> Base.Int64.t
val float : State.t -> lo:Base.Float.t -> hi:Base.Float.t -> Base.Float.t
val unit_float : State.t -> Base.Float.t

unit_float state = float state ~lo:0. ~hi:1., but slightly more efficient (and right endpoint is exclusive).

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct