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

mode

• mode(mu: number, sigma: number): number

• Returns the mode 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

  mode

  Example

  var y = mode( 0.0, 1.0 );
  // returns ~0.368

  Example

  var y = mode( 5.0, 2.0 );
  // returns ~2.718

  Example

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

  Example

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

  Example

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