Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/random

random

npm versionnpm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Pseudo-random number generators w/ unified API, distributions, weighted choices, ID generation.

This package provides the IRandom interface and various (mostly seedable) pseudo-random number generator implementations, incl. IRandom wrappers for Math.random() and window.crypto:

Partially ported from C implementations taken from c.thi.ng.

Random distributions

Other utilities

Status

STABLE - used in production

Search or submit any issues for this package

Related packages

  • @thi.ng/ksuid - Configurable K-sortable unique IDs, ULIDs, binary & base-N encoded, 32/48/64bit time resolutions

Installation

yarn add @thi.ng/random

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/random"></script>

Skypack documentation

For NodeJS (v14.6+):

node --experimental-specifier-resolution=node --experimental-repl-await

> const random = await import("@thi.ng/random");

Package sizes (gzipped, pre-treeshake): ESM: 1.83 KB

Dependencies

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

ScreenshotDescriptionLive demoSource
Probabilistic color theme generatorDemoSource
Interactive inverse FFT toy synthDemoSource
2D Bezier curve-guided particle systemDemoSource
Interactive pixel sorting tool using thi.ng/color & thi.ng/pixelDemoSource
Evolutionary shader generation using genetic programmingDemoSource

API

Generated API docs

import { Smush32 } from "@thi.ng/random";

const rnd = new Smush32(0xdecafbad);

// the following methods are available for all generators

// next uint (0 .. 2^32-1)
rnd.int()
// 4022849029

// next float [0.0 .. 1.0)
rnd.float()
// 0.2698542904737066

// next normalized float (w/ opt scale)
// [-scale .. +scale)
rnd.norm(100)
// 57.70723665079737

// next float in given interval [min .. max)
rnd.minmax(10, 20)
// 15.295951807707537

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-random,
  title = "@thi.ng/random",
  author = "Karsten Schmidt",
  note = "https://thi.ng/random",
  year = 2015
}

License

© 2015 - 2021 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc