Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Functions

kurtosis

  • kurtosis(alpha: number, s: number, m: number): number
  • Returns the excess kurtosis for a Fréchet distribution with shape alpha, scale s, and location m.

    Notes

    • If provided 0 < alpha <= 4 and s > 0, the function returns positive infinity.
    • 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

    excess kurtosis

    Example

    var y = kurtosis( 5.0, 2.0, 0.0 );
    // returns ~45.092

    Example

    var y = kurtosis( 5.0, 2.0, -5.0 );
    // returns ~45.092

    Example

    var y = kurtosis( 3.8, 1.0, 0.0 );
    // returns Infinity

    Example

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

    Example

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

    Example

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