# mersenne-twister-serializable

> A serializable Mersenne Twister

Latest version **1.0.0** (published 2022-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install mersenne-twister-serializable
pnpm add mersenne-twister-serializable
yarn add mersenne-twister-serializable
bun add mersenne-twister-serializable
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-01-14 |
| First published | 2022-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jimb Esser |
| Maintainers | jimbly |
| Keywords | mersenne, twister, mersenne twister, mersennetwister, fast, performance, performant, random, number, generator, seed, seedable, seeded, save, restore, saveable, restorable, serializable, deserializable, rng, prng |

## Links

- npm: https://www.npmjs.com/package/mersenne-twister-serializable
- Repository: https://github.com/Jimbly/mersenne-twister-serializable
- Homepage: https://github.com/Jimbly/mersenne-twister-serializable#readme
- Issues: https://github.com/Jimbly/mersenne-twister-serializable/issues
- npm.io page: https://npm.io/package/mersenne-twister-serializable

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-01-14

## README

# mersenne-twister-serializable

A serializable Mersenne Twister

A modification of [`fast-mersenne-twister`](https://www.npmjs.com/package/fast-mersenne-twister) to support serializing / deserializing (allows to save / restore the seed) and with compatibility enhancements for older browsers/environments.

## Usage

```javascript
const { createMersenneTwister } = require('mersenne-twister-serializable');

let twister = createMersenneTwister(1234567890);

console.log(twister.random()); // 0.6187947695143521

let state = twister.save(); // state is an Object that can be serialized to JSON

console.log(twister.random()); // 0.3405089376028627

twister.restore(state);

console.log(twister.random()); // 0.3405089376028627

let another = createMersenneTwister(state);

console.log(another.random()); // 0.3405089376028627
```

You can also use an array seed:

```javascript
const { createMersenneTwister } = require('mersenne-twister-serializable');

let twister = createMersenneTwister([1234, 5678, 9012]);

console.log(twister.random()); // 0.22977210697717965
```

### Methods

All of the original methods are available on the MersenneTwister object returned by the exported function.

They are also aliased to more readable / convenient names.

| Convenience | Original | Return |
| ----------- | -------- | ------ |
| `randomNumber` | `genrand_int32` | 32 bit integer, [0,0xffffffff] |
| `random31Bit` | `genrand_int31` | 31 bit integer, [0,0x7fffffff] |
| `randomInclusive` | `genrand_real1` | float, [0,1] |
| `random` | `genrand_real2` | float, [0,1) (this is just like what `Math.random()` returns) |
| `randomExclusive` | `genrand_real3` | float, (0,1) |
| `random53Bit` | `genrand_res53` | float, [0,1) with 53-bit resolution |
| `save` | `toJSON` | serializable Object with Number `n` and Array `d` |
| `restore` | `fromJSON` | void |

## Notes

- Extremely true to the [original algorithm by Matsumoto & Nishimura](http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html)
- Converted to JavaScript by [Stephan Brumme](https://create.stephan-brumme.com/mersenne-twister/)
  - This version cannot be initialized with an array
- Updated by Thomas Randolph for compliance and performance
	- with all of the original random generators
	- with the ability to be initialized with an array
	- with the correct range (the original only outputs unsigned integers, while Stephan's version outputs signed integers)
- Updated by Jimb Esser
  - with my code style
  - to support saving/restoring
  - to support older browsers/environments
  - performance optimizations

---
_Source: https://npm.io/package/mersenne-twister-serializable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
