Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/base/dists/lognormal/variance/docs/types/index.d"

Index

Functions

Functions

variance

  • variance(mu: number, sigma: number): number
  • Returns the variance for a lognormal distribution with location mu and scale sigma.

    Notes

    • If provided sigma <= 0, the function returns NaN.

    Parameters

    • mu: number

      location parameter

    • sigma: number

      scale parameter

    Returns number

    variance

    Example

    var y = variance( 0.0, 1.0 );
    // returns ~4.671

    Example

    var y = variance( 5.0, 2.0 );
    // returns ~64457364.853

    Example

    var y = variance( NaN, 1.0 );
    // returns NaN

    Example

    var y = variance( 0.0, NaN );
    // returns NaN

    Example

    var y = variance( 0.0, 0.0 );
    // returns NaN