External module "stats/base/dists/negative-binomial/mode/docs/types/index.d"

mode

• mode(r: number, p: number): number

• Returns the mode of a negative binomial distribution.

  Notes

  • If provided a r which is not a positive number, the function returns NaN.
  • If p < 0 or p > 1, the function returns NaN.

  Parameters

  • r: number

    number of failures until experiment is stopped

  • p: number

    success probability

  Returns number

  mode

  Example

  var v = mode( 100, 0.2 );
  // returns 396

  Example

  var v = mode( 20, 0.5 );
  // returns 19

  Example

  var v = mode( 10.3, 0.8 );
  // returns 2

  Example

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

  Example

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

  Example

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

  Example

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