Interface RandomInt

A configurable random integer generator for the uniform distribution.

interface RandomInt {
    source(source): RandomInt;
    (max): (() => number);
    (min, max): (() => number);
}

Hierarchy

RandomNumberGenerationSource
- RandomInt

RandomInt(max): (() => number)
Returns a function for generating random integers with a uniform distribution. The minimum allowed value of a returned number is ⌊min⌋ (inclusive), and the maximum is ⌊max - 1⌋ (inclusive) Min defaults to 0.
Parameters
- max: number
  The maximum allowed value of a returned number.
Returns (() => number)
- - (): number
  - Returns a function for generating random integers with a uniform distribution. The minimum allowed value of a returned number is ⌊min⌋ (inclusive), and the maximum is ⌊max - 1⌋ (inclusive) Min defaults to 0.
    
    Returns number
RandomInt(min, max): (() => number)
Returns a function for generating random integers with a uniform distribution. The minimum allowed value of a returned number is ⌊min⌋ (inclusive), and the maximum is ⌊max - 1⌋ (inclusive)
Parameters
- min: number
  The minimum allowed value of a returned number.
- max: number
  The maximum allowed value of a returned number.
Returns (() => number)
- - (): number
  - Returns a function for generating random integers with a uniform distribution. The minimum allowed value of a returned number is ⌊min⌋ (inclusive), and the maximum is ⌊max - 1⌋ (inclusive)
    
    Returns number

Index

Methods

Methods

source

source(source): RandomInt
Returns the same type of function for generating random numbers but where the given random number generator source is used as the source of randomness instead of Math.random. This is useful when a seeded random number generator is preferable to Math.random.
Parameters
- source: (() => number)
  Source (pseudo-)random number generator implementing the Math.random interface. The given random number generator must implement the same interface as Math.random and only return values in the range [0, 1).
  - - (): number
    - Returns number
Returns RandomInt
Inherited from RandomNumberGenerationSource.source