Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogNormal

Represents a random variable with a log-normal distribution with given mean and standard deviation values.

For more information on log-normal distributions see log-normal distribution.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new LogNormal(mean: number, std: number, seed?: number): LogNormal

  • Initializes a new instance of the LogNormal class.

    Parameters

    • mean: number

      Mean generated value.

    • std: number

      Standard deviation of the generated values.

    • Optional seed: number

      Optional value used to initialize the random sequence.

    Returns LogNormal

Accessors

mean

  • get mean(): number

  • Gets the mean value of the generated values.

    Returns number

std

  • get std(): number

  • Gets the standard deviation of the generated values.

    Returns number

Methods

sample

  • sample(): number

  • Gets a random value that follows a lognormal distribution with a given mean and standard deviation (std).

    Returns number

Generated using TypeDoc