Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Functions

Functions

stdev

  • stdev(alpha: number, beta: number): number
  • Returns the standard deviation of an inverse gamma distribution.

    Notes

    • If alpha <= 0 or beta <= 0, the function returns NaN.

    Parameters

    • alpha: number

      shape parameter

    • beta: number

      rate parameter

    Returns number

    standard deviation

    Example

    var v = stdev( 3.0, 5.0 );
    // returns ~2.5

    Example

    var v = stdev( 4.0, 12.0 );
    // returns ~2.828

    Example

    var v = stdev( 8.0, 2.0 );
    // returns ~0.117

    Example

    var v = stdev( 3.0, -0.1 );
    // returns NaN

    Example

    var v = stdev( 1.5, 1.0 );
    // returns NaN

    Example

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

    Example

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