Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Functions

entropy

  • entropy(v: number): number
  • Returns the differential entropy of a Student's t distribution.

    Notes

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

    Parameters

    • v: number

      degrees of freedom

    Returns number

    entropy

    Example

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

    Example

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

    Example

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

    Example

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