Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Functions

stdev

  • stdev(v: number): number
  • Returns the standard deviation of a Student's t distribution.

    Notes

    • If provided 1 < v <= 2, the function returns positive infinity.
    • If provided v <= 1, the function returns NaN.

    Parameters

    • v: number

      degrees of freedom

    Returns number

    standard deviation

    Example

    var v = stdev( 9.0 );
    // returns ~1.134

    Example

    var v = stdev( 2.0 );
    // returns Infinity

    Example

    var v = stdev( 0.5 );
    // returns NaN

    Example

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

    Example

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