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

mode

• mode(alpha: number, beta: number): number

• Returns the mode of a beta prime distribution.

  Notes

  • If alpha <= 0 or beta <= 0, the function returns NaN.

  Parameters

  • alpha: number

    first shape parameter

  • beta: number

    second shape parameter

  Returns number

  mode

  Example

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

  Example

  var v = mode( 4.0, 12.0 );
  // returns ~0.231

  Example

  var v = mode( 8.0, 2.0 );
  // returns ~2.333

  Example

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

  Example

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

  Example

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

  Example

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

  Example

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