Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Functions

entropy

  • entropy(k: number): number
  • Returns the differential entropy of a chi distribution (in nats).

    Notes

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

    Parameters

    • k: number

      degrees of freedom

    Returns number

    entropy

    Example

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

    Example

    var v = entropy( 1.0 );
    // returns ~0.726

    Example

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

    Example

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