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/Generator/classes/PseudoRandomGenerator.md DELETED Viewed

@@ -1,258 +0,0 @@
-[Home](../../README.md) > [Generator](../README.md) > PseudoRandomGenerator
-# Class: PseudoRandomGenerator
-A pseudo-random number generator that can be used to generate random values
-of various shapes.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[rng](./PseudoRandomGenerator.rng.md)
-</td><td>
-`readonly`
-</td><td>
-[SeededRandomSource](../../classes/SeededRandomSource.md)
-</td><td>
-The underlying random number generator.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody>
-<tr><td>
-[create(params)](./PseudoRandomGenerator.create.md)
-</td><td>
-`static`
-</td><td>
-Creates a new pseudo-random number generator.
-</td></tr>
-<tr><td>
-[setGlobalRng(rng)](./PseudoRandomGenerator.setGlobalRng.md)
-</td><td>
-`static`
-</td><td>
-Sets this generator as the global random number generator.
-</td></tr>
-<tr><td>
-[getGlobalRng()](./PseudoRandomGenerator.getGlobalRng.md)
-</td><td>
-`static`
-</td><td>
-Gets the global random number generator.
-</td></tr>
-<tr><td>
-[ensureRng(rng)](./PseudoRandomGenerator.ensureRng.md)
-</td><td>
-`static`
-</td><td>
-Ensures a random number generator is available, using the global generator if available
-</td></tr>
-<tr><td>
-[clone()](./PseudoRandomGenerator.clone.md)
-</td><td>
-</td><td>
-Creates a clone of this generator.
-</td></tr>
-<tr><td>
-[createChild(label)](./PseudoRandomGenerator.createChild.md)
-</td><td>
-</td><td>
-Creates a child generator with the given label.
-</td></tr>
-<tr><td>
-[nextFloat()](./PseudoRandomGenerator.nextFloat.md)
-</td><td>
-</td><td>
-Generates a random float between 0 and 1.
-</td></tr>
-<tr><td>
-[nextInt(extent)](./PseudoRandomGenerator.nextInt.md)
-</td><td>
-</td><td>
-Generates a random integer between 0 and the specified extent (positive or negative).
-</td></tr>
-<tr><td>
-[nextInRange(min, max)](./PseudoRandomGenerator.nextInRange.md)
-</td><td>
-</td><td>
-Generates a random integer between the specified minimum and maximum values.
-</td></tr>
-<tr><td>
-[nextBoolean(trueProbability)](./PseudoRandomGenerator.nextBoolean.md)
-</td><td>
-</td><td>
-Generates a random boolean value.
-</td></tr>
-<tr><td>
-[nextString(length, chars)](./PseudoRandomGenerator.nextString.md)
-</td><td>
-</td><td>
-Generates a random string of the specified length using the given characters.
-</td></tr>
-<tr><td>
-[pickNext(items)](./PseudoRandomGenerator.pickNext.md)
-</td><td>
-</td><td>
-Generates a random item from the given array.
-</td></tr>
-<tr><td>
-[pickSequential(params)](./PseudoRandomGenerator.pickSequential.md)
-</td><td>
-</td><td>
-Generates a sequence of values by randomly selecting from the given candidate
-</td></tr>
-<tr><td>
-[pickRandom(params)](./PseudoRandomGenerator.pickRandom.md)
-</td><td>
-</td><td>
-Generates a sequence of values by randomly selecting from the supplied
-</td></tr>
-<tr><td>
-[pickSequence(params)](./PseudoRandomGenerator.pickSequence.md)
-</td><td>
-</td><td>
-Generates a sequence of values by randomly selecting from the given candidates.
-</td></tr>
-</tbody></table>

package/docs/Generator/classes/PseudoRandomGenerator.nextBoolean.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextBoolean
-## PseudoRandomGenerator.nextBoolean() method
-Generates a random boolean value.
-**Signature:**
-```typescript
-nextBoolean(trueProbability: number): boolean;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>trueProbability</td><td>number</td><td>The probability of returning true (default is 0.5).</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-A random boolean value.

package/docs/Generator/classes/PseudoRandomGenerator.nextFloat.md DELETED Viewed

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

package/docs/Generator/classes/PseudoRandomGenerator.nextInRange.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextInRange
-## PseudoRandomGenerator.nextInRange() method
-Generates a random integer between the specified minimum and maximum values.
-**Signature:**
-```typescript
-nextInRange(min: number | undefined, max: number | undefined): number;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>min</td><td>number | undefined</td><td>The minimum value (inclusive).</td></tr>
-<tr><td>max</td><td>number | undefined</td><td>The maximum value (inclusive).</td></tr>
-</tbody></table>
-**Returns:**
-number
-A random integer between the specified minimum and maximum values.

package/docs/Generator/classes/PseudoRandomGenerator.nextInt.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [Generator](../README.md) > [PseudoRandomGenerator](./PseudoRandomGenerator.md) > nextInt
-## PseudoRandomGenerator.nextInt() method
-Generates a random integer between 0 and the specified extent (positive or negative).
-**Signature:**
-```typescript
-nextInt(extent?: number): number;
-```
-**Parameters:**
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>extent</td><td>number</td><td>The maximum (or minimum) value (exclusive).</td></tr>
-</tbody></table>
-**Returns:**
-number
-A random integer between 0 and the specified extent.

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

@@ -1,25 +0,0 @@
-[Home](../../README.md) > [Generator](../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/Generator/classes/PseudoRandomGenerator.pickNext.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [Generator](../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/Generator/classes/PseudoRandomGenerator.pickRandom.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../../README.md) > [Generator](../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/Generator/classes/PseudoRandomGenerator.pickSequence.md DELETED Viewed

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [Generator](../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/Generator/classes/PseudoRandomGenerator.pickSequential.md DELETED Viewed

@@ -1,25 +0,0 @@
-[Home](../../README.md) > [Generator](../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/Generator/classes/PseudoRandomGenerator.rng.md DELETED Viewed

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

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

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [Generator](../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](../../classes/PseudoRandomGenerator.md) | undefined
-A result containing this generator or an error.

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

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

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

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

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

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [Generator](../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](../../classes/SeededRandomSource.md)&gt;
-A new seeded random source.

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

@@ -1,24 +0,0 @@
-[Home](../../README.md) > [Generator](../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](../../classes/SeededRandomSource.md)
-A new seeded random source with a hashed state and label.

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

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

@@ -1,25 +0,0 @@
-[Home](../../README.md) > [Generator](../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/Generator/classes/SeededRandomSource.lineage.md DELETED Viewed

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