ml-xsadd

ml-xsadd

Maintained by Zakodium

JavaScript implementation of the XORSHIFT-ADD (XSadd) pseudo random number generator.

Based on the C code from https://github.com/MersenneTwister-Lab/XSadd.

Installation

$ npm install ml-xsadd

API

const { XSadd } = require("ml-xsadd");

const gen = new XSadd();
const number = gen.getFloat();

new XSadd([seed])

Creates a new XSadd instance. Seed is an optional integer that defaults to Date.now().

getUint32()

Returns a 32-bit integer r (0 <= r < 2^32).

getFloat()

Returns a floating point number r (0.0 <= r < 1.0).

random()

Like getFloat() but dynamically bound to the XSadd instance.
You can use this function externally, like Math.random:

const xsadd = new XSadd();
const random = xsadd.random;
const number = random();

init(seed)

Reinitialize the generator with a new seed.

LICENSE

MIT

Changelog

3.0.0 (2024-10-17)

⚠ BREAKING CHANGES

• Remove default export. You need to "import {XSadd} from 'xsadd'"

Features

• Remove default export. You need to "import {XSadd} from 'xsadd'" (ac4275b)

<a name="2.0.0"></a>