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

entropy

• entropy(alpha: number, s: number, m: number): number

• Returns the differential entropy for a Fréchet distribution with shape alpha, scale s, and location m.

  Notes

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

  Parameters

  • alpha: number

    shape parameter

  • s: number

    scale parameter

  • m: number

    location parameter

  Returns number

  entropy

  Example

  var y = entropy( 1.0, 1.0, 0.0 );
  // returns ~2.154

  Example

  var y = entropy( 5.0, 2.0, 0.0 );
  // returns ~0.776

  Example

  var y = entropy( NaN, 1.0, 0.0 );
  // returns NaN

  Example

  var y = entropy( 1.0, NaN, 0.0 );
  // returns NaN

  Example

  var y = entropy( 1.0, 1.0, NaN );
  // returns NaN