npm - @fgv/ts-random - Versions diffs - 5.1.0-19 → 5.1.0-20 - Mend

@fgv/ts-random 5.1.0-19 → 5.1.0-20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (273) hide show

package/docs/classes/PseudoRandomGenerator.nextString.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextString
-## PseudoRandomGenerator.nextString() method
-Generates a random string of the specified length using the given characters.
-**Signature:**
-```typescript
-nextString(length: number, chars: string): string;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>length</td><td>number</td><td>The length of the string to generate.</td></tr>
-<tr><td>chars</td><td>string</td><td>The characters to use for the string (default is alphanumeric).</td></tr>
-</tbody></table>
-**Returns:**
-string
-A random string of the specified length.

package/docs/classes/PseudoRandomGenerator.pickNext.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > pickNext
-## PseudoRandomGenerator.pickNext() method
-Generates a random item from the given array.
-**Signature:**
-```typescript
-pickNext(items?: readonly T[]): T | undefined;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>items</td><td>readonly T[]</td><td>The array to select from.</td></tr>
-</tbody></table>
-**Returns:**
-T | undefined
-A random item from the array or undefined if the array is empty.

package/docs/classes/PseudoRandomGenerator.pickRandom.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > pickRandom
-## PseudoRandomGenerator.pickRandom() method
-Generates a sequence of values by randomly selecting from the supplied
-dictionaries in random order.
-**Signature:**
-```typescript
-pickRandom(params: IRandomSequencePickParams<T>): readonly T[];
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>params</td><td>IRandomSequencePickParams&lt;T&gt;</td><td>The parameters for generating the sequence.</td></tr>
-</tbody></table>
-**Returns:**
-readonly T[]
-A sequence of values.

package/docs/classes/PseudoRandomGenerator.pickSequence.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > pickSequence
-## PseudoRandomGenerator.pickSequence() method
-Generates a sequence of values by randomly selecting from the given candidates.
-**Signature:**
-```typescript
-pickSequence(params: SequencePickParams<T>): readonly T[];
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>params</td><td>SequencePickParams&lt;T&gt;</td><td>The parameters for generating the sequence.</td></tr>
-</tbody></table>
-**Returns:**
-readonly T[]
-A sequence of values.

package/docs/classes/PseudoRandomGenerator.pickSequential.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > pickSequential
-## PseudoRandomGenerator.pickSequential() method
-Generates a sequence of values by randomly selecting from the given candidate
-dictionaries in order.
-**Signature:**
-```typescript
-pickSequential(params: ISequentialPickParams<T>): readonly T[];
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>params</td><td>ISequentialPickParams&lt;T&gt;</td><td>The parameters for generating the sequence.</td></tr>
-</tbody></table>
-**Returns:**
-readonly T[]
-A sequence of values.

package/docs/classes/PseudoRandomGenerator.rng.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > rng
-## PseudoRandomGenerator.rng property
-The underlying random number generator.
-**Signature:**
-```typescript
-readonly rng: SeededRandomSource;
-```

package/docs/classes/PseudoRandomGenerator.setGlobalRng.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > setGlobalRng
-## PseudoRandomGenerator.setGlobalRng() method
-Sets this generator as the global random number generator.
-**Signature:**
-```typescript
-static setGlobalRng(rng?: PseudoRandomGenerator): PseudoRandomGenerator | undefined;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>rng</td><td>PseudoRandomGenerator</td><td></td></tr>
-</tbody></table>
-**Returns:**
-[PseudoRandomGenerator](PseudoRandomGenerator.md) | undefined
-A result containing this generator or an error.

package/docs/classes/SeededRandomSource.clone.md DELETED Viewed

@@ -1,17 +0,0 @@
-[Home](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > clone
-## SeededRandomSource.clone() method
-Creates a clone of this random source.
-**Signature:**
-```typescript
-clone(): SeededRandomSource;
-```
-**Returns:**
-[SeededRandomSource](SeededRandomSource.md)
-A new seeded random source with the same state.

package/docs/classes/SeededRandomSource.counter.md DELETED Viewed

@@ -1,11 +0,0 @@
-[Home](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > counter
-## SeededRandomSource.counter property
-Gets the current counter value.
-**Signature:**
-```typescript
-readonly counter: number;
-```

package/docs/classes/SeededRandomSource.create.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > create
-## SeededRandomSource.create() method
-Creates a new seeded random source from an optional seed.
-**Signature:**
-```typescript
-static create(seed?: string | number): Result<SeededRandomSource>;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>seed</td><td>string | number</td><td>The optional seed value.</td></tr>
-</tbody></table>
-**Returns:**
-Result&lt;[SeededRandomSource](SeededRandomSource.md)&gt;
-A new seeded random source.

package/docs/classes/SeededRandomSource.createChild.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > createChild
-## SeededRandomSource.createChild() method
-Creates a child random source with a label.
-**Signature:**
-```typescript
-createChild(label: string): SeededRandomSource;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>label</td><td>string</td><td>The label for the child.</td></tr>
-</tbody></table>
-**Returns:**
-[SeededRandomSource](SeededRandomSource.md)
-A new seeded random source with a hashed state and label.

package/docs/classes/SeededRandomSource.hashSeed.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > hashSeed
-## SeededRandomSource.hashSeed() method
-Hashes a seed value.
-**Signature:**
-```typescript
-static hashSeed(seed: string | number): ISeedPair;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>seed</td><td>string | number</td><td>The seed value.</td></tr>
-</tbody></table>
-**Returns:**
-[ISeedPair](../interfaces/ISeedPair.md)
-A hashed seed value.

package/docs/classes/SeededRandomSource.hashStateAndLabel.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../README.md) > [SeededRandomSource](./SeededRandomSource.md) > hashStateAndLabel
-## SeededRandomSource.hashStateAndLabel() method
-Hashes a state and label.
-**Signature:**
-```typescript
-static hashStateAndLabel(state: number, label: string): ISeedPair;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>state</td><td>number</td><td>The state value.</td></tr>
-<tr><td>label</td><td>string</td><td>The label value.</td></tr>
-</tbody></table>
-**Returns:**
-[ISeedPair](../interfaces/ISeedPair.md)
-A hashed state and label value.

package/docs/classes/SeededRandomSource.lineage.md DELETED Viewed

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

package/docs/classes/SeededRandomSource.md DELETED Viewed

@@ -1,187 +0,0 @@
-[Home](../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/classes/SeededRandomSource.mulberryStep.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../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/classes/SeededRandomSource.next.md DELETED Viewed

@@ -1,17 +0,0 @@
-[Home](../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/classes/SeededRandomSource.seed.md DELETED Viewed

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

package/docs/interfaces/INextResult.md DELETED Viewed

@@ -1,61 +0,0 @@
-[Home](../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/interfaces/INextResult.nextState.md DELETED Viewed

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

package/docs/interfaces/INextResult.value.md DELETED Viewed

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

package/docs/interfaces/IPseudoRandomGeneratorCreateParams.global.md DELETED Viewed

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