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

mode

• mode(p: number): number

• Returns the mode of a Bernoulli distribution.

  Notes

  • If p < 0 or p > 1, the function returns NaN.
  • For p = 0.5, the mode is either 0 or 1. This function returns 0 for p = 0.5.

  Parameters

  • p: number

    success probability

  Returns number

  mode

  Example

  var v = mode( 0.1 );
  // returns 0

  Example

  var v = mode( 0.8 );
  // returns 1

  Example

  var v = mode( 0.5 );
  // returns 0

  Example

  var v = mode( 1.1 );
  // returns NaN

  Example

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