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

entropy

• entropy(sigma: number): number

• Returns the differential entropy of a Rayleigh distribution.

  Notes

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

  Parameters

  • sigma: number

    scale parameter

  Returns number

  entropy

  Example

  var v = entropy( 9.0 );
  // returns ~3.139

  Example

  var v = entropy( 2.0 );
  // returns ~1.635

  Example

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

  Example

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