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

entropy

• entropy(d1: number, d2: number): number

• Returns the differential entropy of an F distribution.

  Notes

  • If d1 <= 0 or d2 <= 0, the function returns NaN.

  Parameters

  • d1: number

    numerator degrees of freedom

  • d2: number

    denominator degrees of freedom

  Returns number

  entropy

  Example

  var v = entropy( 3.0, 7.0 );
  // returns ~1.298

  Example

  var v = entropy( 4.0, 12.0 );
  // returns ~1.12

  Example

  var v = entropy( 8.0, 7.0 );
  // returns ~1.193

  Example

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

  Example

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

  Example

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

  Example

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