@fgv/ts-random 5.1.0-8

package/docs/Generator/classes/SeededRandomSource.md

@@ -0,0 +1,187 @@
+[Home](../../README.md) > [Generator](../README.md) > SeededRandomSource
+
+# Class: SeededRandomSource
+
+Seeded random number generator that can be cloned and used for deterministic generation.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[seed](./SeededRandomSource.seed.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[lineage](./SeededRandomSource.lineage.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+readonly string[]
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[counter](./SeededRandomSource.counter.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+number
+
+</td><td>
+
+Gets the current counter value.
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[create(seed)](./SeededRandomSource.create.md)
+
+</td><td>
+
+`static`
+
+</td><td>
+
+Creates a new seeded random source from an optional seed.
+
+</td></tr>
+<tr><td>
+
+[mulberryStep(currentState)](./SeededRandomSource.mulberryStep.md)
+
+</td><td>
+
+`static`
+
+</td><td>
+
+Steps a mulberry32 random number generator state and returns the next value.
+
+</td></tr>
+<tr><td>
+
+[hashSeed(seed)](./SeededRandomSource.hashSeed.md)
+
+</td><td>
+
+`static`
+
+</td><td>
+
+Hashes a seed value.
+
+</td></tr>
+<tr><td>
+
+[hashStateAndLabel(state, label)](./SeededRandomSource.hashStateAndLabel.md)
+
+</td><td>
+
+`static`
+
+</td><td>
+
+Hashes a state and label.
+
+</td></tr>
+<tr><td>
+
+[next()](./SeededRandomSource.next.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Generates the next random number.
+
+</td></tr>
+<tr><td>
+
+[clone()](./SeededRandomSource.clone.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Creates a clone of this random source.
+
+</td></tr>
+<tr><td>
+
+[createChild(label)](./SeededRandomSource.createChild.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Creates a child random source with a label.
+
+</td></tr>
+</tbody></table>

package/docs/Generator/classes/SeededRandomSource.mulberryStep.md

@@ -0,0 +1,24 @@
+[Home](../../README.md) > [Generator](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > mulberryStep
+
+## SeededRandomSource.mulberryStep() method
+
+Steps a mulberry32 random number generator state and returns the next value.
+
+**Signature:**
+
+```typescript
+static mulberryStep(currentState: number): INextResult;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>currentState</td><td>number</td><td>The current state of the generator.</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[INextResult](../../interfaces/INextResult.md)
+
+The next random number and the next state.

package/docs/Generator/classes/SeededRandomSource.next.md

@@ -0,0 +1,17 @@
+[Home](../../README.md) > [Generator](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > next
+
+## SeededRandomSource.next() method
+
+Generates the next random number.
+
+**Signature:**
+
+```typescript
+next(): number;
+```
+
+**Returns:**
+
+number
+
+A random number between 0 and 1.

package/docs/Generator/classes/SeededRandomSource.seed.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > seed
+
+## SeededRandomSource.seed property
+
+**Signature:**
+
+```typescript
+readonly seed: string;
+```

package/docs/Generator/interfaces/INextResult.md

@@ -0,0 +1,61 @@
+[Home](../../README.md) > [Generator](../README.md) > INextResult
+
+# Interface: INextResult
+
+Result of an internal next() operation.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[value](./INextResult.value.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[nextState](./INextResult.nextState.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/Generator/interfaces/INextResult.nextState.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [INextResult](./INextResult.md) > nextState
+
+## INextResult.nextState property
+
+**Signature:**
+
+```typescript
+nextState: number;
+```

package/docs/Generator/interfaces/INextResult.value.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [INextResult](./INextResult.md) > value
+
+## INextResult.value property
+
+**Signature:**
+
+```typescript
+value: number;
+```

package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.global.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [IPseudoRandomGeneratorCreateParams](./IPseudoRandomGeneratorCreateParams.md) > global
+
+## IPseudoRandomGeneratorCreateParams.global property
+
+**Signature:**
+
+```typescript
+global: boolean;
+```

package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.md

@@ -0,0 +1,78 @@
+[Home](../../README.md) > [Generator](../README.md) > IPseudoRandomGeneratorCreateParams
+
+# Interface: IPseudoRandomGeneratorCreateParams
+
+Parameters for creating a generator.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[seed](./IPseudoRandomGeneratorCreateParams.seed.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string | number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[step](./IPseudoRandomGeneratorCreateParams.step.md)
+
+</td><td>
+
+
+
+</td><td>
+
+[RandomStepFunction](../../type-aliases/RandomStepFunction.md)
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[global](./IPseudoRandomGeneratorCreateParams.global.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.seed.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [IPseudoRandomGeneratorCreateParams](./IPseudoRandomGeneratorCreateParams.md) > seed
+
+## IPseudoRandomGeneratorCreateParams.seed property
+
+**Signature:**
+
+```typescript
+seed: string | number;
+```

package/docs/Generator/interfaces/IPseudoRandomGeneratorCreateParams.step.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [IPseudoRandomGeneratorCreateParams](./IPseudoRandomGeneratorCreateParams.md) > step
+
+## IPseudoRandomGeneratorCreateParams.step property
+
+**Signature:**
+
+```typescript
+step: RandomStepFunction;
+```

package/docs/Generator/interfaces/IRandomSequencePickParams.candidates.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > candidates
+
+## IRandomSequencePickParams.candidates property
+
+**Signature:**
+
+```typescript
+candidates: readonly T[];
+```

package/docs/Generator/interfaces/IRandomSequencePickParams.count.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > count
+
+## IRandomSequencePickParams.count property
+
+**Signature:**
+
+```typescript
+count: number;
+```

package/docs/Generator/interfaces/IRandomSequencePickParams.how.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [IRandomSequencePickParams](./IRandomSequencePickParams.md) > how
+
+## IRandomSequencePickParams.how property
+
+**Signature:**
+
+```typescript
+how: "random";
+```

package/docs/Generator/interfaces/IRandomSequencePickParams.md

@@ -0,0 +1,79 @@
+[Home](../../README.md) > [Generator](../README.md) > IRandomSequencePickParams
+
+# Interface: IRandomSequencePickParams
+
+Parameters for generating a sequence of values
+by randomly selecting from dictionaries in a supplied set.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[how](./IRandomSequencePickParams.how.md)
+
+</td><td>
+
+
+
+</td><td>
+
+"random"
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[count](./IRandomSequencePickParams.count.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[candidates](./IRandomSequencePickParams.candidates.md)
+
+</td><td>
+
+
+
+</td><td>
+
+readonly T[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/Generator/interfaces/ISeedPair.md

@@ -0,0 +1,61 @@
+[Home](../../README.md) > [Generator](../README.md) > ISeedPair
+
+# Interface: ISeedPair
+
+Represents a seed as both a string and a number.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[seed](./ISeedPair.seed.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[state](./ISeedPair.state.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/Generator/interfaces/ISeedPair.seed.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [ISeedPair](./ISeedPair.md) > seed
+
+## ISeedPair.seed property
+
+**Signature:**
+
+```typescript
+seed: string;
+```

package/docs/Generator/interfaces/ISeedPair.state.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [ISeedPair](./ISeedPair.md) > state
+
+## ISeedPair.state property
+
+**Signature:**
+
+```typescript
+state: number;
+```

package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.counter.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > counter
+
+## ISeededRandomSourceConstructorParams.counter property
+
+**Signature:**
+
+```typescript
+counter: number;
+```

package/docs/Generator/interfaces/ISeededRandomSourceConstructorParams.lineage.md

@@ -0,0 +1,9 @@
+[Home](../../README.md) > [Generator](../README.md) > [ISeededRandomSourceConstructorParams](./ISeededRandomSourceConstructorParams.md) > lineage
+
+## ISeededRandomSourceConstructorParams.lineage property
+
+**Signature:**
+
+```typescript
+lineage: readonly string[];
+```