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

mode

• mode(k: number, lambda: number): number

• Returns the mode of an Erlang distribution.

  Notes

  • If not provided a positive integer for k, the function returns NaN.
  • If provided a non-positive value for lambda, the function returns NaN.

  Parameters

  • k: number

    shape parameter

  • lambda: number

    rate parameter

  Returns number

  mode

  Example

  var v = mode( 1, 1.0 );
  // returns 0.0

  Example

  var v = mode( 4, 12.0 );
  // returns 0.25

  Example

  var v = mode( 8, 2.0 );
  // returns 3.5

  Example

  var v = mode( 1.5, 2.0 );
  // returns NaN

  Example

  var v = mode( 1, -0.1 );
  // returns NaN

  Example

  var v = mode( -0.1, 1.0 );
  // returns NaN

  Example

  var v = mode( 2, NaN );
  // returns NaN

  Example

  var v = mode( NaN, 2.0 );
  // returns NaN