Interface RandomLogNormal

A configurable random number generator for the log-normal distribution.

interface RandomLogNormal {
source(source): RandomLogNormal;
(mu?, sigma?): (() => number);
}

Hierarchy

RandomNumberGenerationSource
- RandomLogNormal

RandomLogNormal(mu?, sigma?): (() => number)
Returns a function for generating random numbers with a log-normal distribution. The expected value of the random variable’s natural logarithm is mu, with the given standard deviation sigma. If mu is not specified, it defaults to 0; if sigma is not specified, it defaults to 1.
Parameters
- Optional mu: number
  Expected value, defaults to 0.
- Optional sigma: number
  Standard deviation, defaults to 1.
Returns (() => number)
- - (): number
  - Returns a function for generating random numbers with a log-normal distribution. The expected value of the random variable’s natural logarithm is mu, with the given standard deviation sigma. If mu is not specified, it defaults to 0; if sigma is not specified, it defaults to 1.
    
    Returns number

Index

Methods

Methods

source

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