Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/base/dists/pareto-type1/stdev/docs/types/index.d"

Index

Functions

Functions

stdev

  • stdev(alpha: number, beta: number): number
  • Returns the standard deviation of a Pareto (Type I) distribution.

    Notes

    • If 0 < alpha <= 2 and beta > 0, the function returns positive infinity.
    • If alpha <= 0 or beta <= 0, the function returns NaN.

    Parameters

    • alpha: number

      shape parameter

    • beta: number

      scale parameter

    Returns number

    standard deviation

    Example

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

    Example

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

    Example

    var v = stdev( 1.0, 1.0 );
    // returns Infinity

    Example

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

    Example

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

    Example

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

    Example

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