Interface RandomBinomial

A configurable random number generator with a binomial distribution.

interface RandomBinomial {
source(source): RandomBinomial;
(p): (() => number);
}

Hierarchy

RandomNumberGenerationSource
- RandomBinomial

RandomBinomial(p): (() => number)
Returns a function for generating numbers with a geometric distribution with success probability p. The value p is in the range (0, 1].
Parameters
- p: number
  Success probability
Returns (() => number)
- - (): number
  - Returns a function for generating numbers with a geometric distribution with success probability p. The value p is in the range (0, 1].
    
    Returns number

Index

Methods

Methods

source

source(source): RandomBinomial
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 RandomBinomial
Inherited from RandomNumberGenerationSource.source