Interface RandomGamma

A configurable random number generator with a gamma distribution.

interface RandomGamma {
source(source): RandomGamma;
(k, theta?): (() => number);
}

Hierarchy

RandomNumberGenerationSource
- RandomGamma

RandomGamma(k, theta?): (() => number)
Returns a function for generating random numbers with a gamma distribution with k the shape parameter and theta the scale parameter. The value k must be a positive value; if theta is not specified, it defaults to 1.
Parameters
- k: number
  Shape parameter
- Optional theta: number
  Scale paramter
Returns (() => number)
- - (): number
  - Returns a function for generating random numbers with a gamma distribution with k the shape parameter and theta the scale parameter. The value k must be a positive value; if theta is not specified, it defaults to 1.
    
    Returns number

Index

Methods

Methods

source

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