ml-xsadd

Maintained by Zakodium

[![NPM version][npm-image]][npm-url]
[![build status][ci-image]][ci-url]
[![npm download][download-image]][download-url]

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

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

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

$3

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

$3

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

$3

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

$3

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

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

$3

Reinitialize the generator with a new seed.

LICENSE

MIT

[npm-image]: https://img.shields.io/npm/v/ml-xsadd.svg?style=flat-square
[npm-url]: https://npmjs.org/package/ml-xsadd
[ci-image]: https://github.com/mljs/xsadd/workflows/Node.js%20CI/badge.svg?branch=main
[ci-url]: https://github.com/mljs/xsadd/actions?query=workflow%3A%22Node.js+CI%22
[download-image]: https://img.shields.io/npm/dm/ml-xsadd.svg?style=flat-square
[download-url]: https://npmjs.org/package/ml-xsadd