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

mean

• mean(sigma: number): number

• Returns the expected value of a Rayleigh distribution.

  Notes

  • If provided σ < 0, the function returns NaN.

  Parameters

  • sigma: number

    scale parameter

  Returns number

  expected value

  Example

  var v = mean( 9.0 );
  // returns ~11.28

  Example

  var v = mean( 2.0 );
  // returns ~2.507

  Example

  var v = mean( -0.2 );
  // returns NaN

  Example

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