Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Functions

entropy

  • entropy(lambda: number): number
  • Returns the entropy of an exponential distribution.

    Notes

    • If provided a negative value for λ, the function returns NaN.

    Parameters

    • lambda: number

      rate parameter

    Returns number

    entropy

    Example

    var v = entropy( 9.0 );
    // returns ~-1.197

    Example

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

    Example

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

    Example

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