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

mean

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

• Returns the expected value of a beta prime distribution.

  Notes

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

  Parameters

  • alpha: number

    first shape parameter

  • beta: number

    second shape parameter

  Returns number

  expected value

  Example

  var v = mean( 1.0, 2.0 );
  // returns 1.0

  Example

  var v = mean( 4.0, 12.0 );
  // returns ~0.364

  Example

  var v = mean( 8.0, 2.0 );
  // returns 8.0

  Example

  var v = mean( 1.0, 1.0 );
  // returns NaN

  Example

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

  Example

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

  Example

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

  Example

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