Class RandomGenerator

A PRNG seeded random number generator

Implements

IterableIterator<number>

Index

Constructors

Properties

Methods

[iterator] next weightedRandom xmur3 sfc32

Constructors

constructor

new RandomGenerator(seed: string): RandomGenerator
Parameters
- seed: string
Returns RandomGenerator
- Defined in packages/wang-tiles/src/lib/prng.ts:15

Properties

`Private` `Readonly`rand

rand: () => number

Methods

[iterator]

"[iterator]"(): IterableIterator<number>
Generate a random number in for loops (infinitely)

Returns IterableIterator<number>

Yields
the next random number
Implementation of IterableIterator.[iterator]
- Defined in packages/wang-tiles/src/lib/prng.ts:68

next

next(): IteratorResult<number, number>
Get the next random number.

Returns IteratorResult<number, number>
the next random number.
Implementation of IterableIterator.next
- Defined in packages/wang-tiles/src/lib/prng.ts:76

weightedRandom

weightedRandom<T>(possibleElements: WeightedArray<T>): T
Get a random element from an array of possible elements based on weight.
Type Parameters
- T
Parameters
- possibleElements: WeightedArray<T>
  A weighted array of elements to select randomly from.
Returns T
A random element from the weighted array.
- Defined in packages/wang-tiles/src/lib/prng.ts:88

`Private`xmur3

xmur3(str: string): () => number
Hash function for generating seeds from strings using xmur3. https://github.com/bryc/code/blob/master/jshash/PRNGs.md
Parameters
- str: string
  The string to generate a seed from.
Returns () => number
A function which returns a different number on each call.
- Defined in packages/wang-tiles/src/lib/prng.ts:26

`Private`sfc32

sfc32(a: number, b: number, c: number, d: number): () => number
"Small Fast Counter" seed generator, chosen for high bit randomness and speed. https://github.com/bryc/code/blob/master/jshash/PRNGs.md
Parameters
- a: number
  Seed Number 1
- b: number
  Seed Number 2
- c: number
  Seed Number 3
- d: number
  Seed Number 4
Returns () => number
A random seed.
- Defined in packages/wang-tiles/src/lib/prng.ts:48