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

mode

• mode(x0: number, gamma: number): number

• Returns the mode of a Cauchy distribution.

  Notes

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

  Parameters

  • x0: number

    location parameter

  • gamma: number

    scale parameter

  Returns number

  mode

  Example

  var v = mode( 10.0, 5.0 );
  // returns 10.0

  Example

  var v = mode( 7.0, 0.1 );
  // returns 7.0

  Example

  var v = mode( 10.0, -0.5 );
  // returns NaN