Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/base/dists/hypergeometric/variance/docs/types/index.d"

Index

Functions

Functions

variance

  • variance(N: number, K: number, n: number): number
  • Returns the variance of a hypergeometric distribution.

    Notes

    • If provided a population size N, subpopulation size K or draws n which is not a nonnegative integer, the function returns NaN.
    • If the number of draws n or subpopulation size K exceed population size N, the function returns NaN.

    Parameters

    • N: number

      population size

    • K: number

      subpopulation size

    • n: number

      number of draws

    Returns number

    variance

    Example

    var v = variance( 16, 11, 4 );
    // returns ~0.688

    Example

    var v = variance( 2, 1, 1 );
    // returns 0.25

    Example

    var v = variance( 10, 5, 12 );
    // returns NaN

    Example

    var v = variance( 10.3, 10, 4 );
    // returns NaN

    Example

    var v = variance( 10, 5.5, 4 );
    // returns NaN

    Example

    var v = variance( 10, 5, 4.5 );
    // returns NaN

    Example

    var v = variance( NaN, 10, 4 );
    // returns NaN

    Example

    var v = variance( 20, NaN, 4 );
    // returns NaN

    Example

    var v = variance( 20, 10, NaN );
    // returns NaN