Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/base/dists/negative-binomial/variance/docs/types/index.d"

Index

Functions

Functions

variance

  • variance(r: number, p: number): number
  • Returns the variance of a negative binomial distribution.

    Notes

    • If provided a r which is not a positive number, the function returns NaN.
    • If p < 0 or p > 1, the function returns NaN.

    Parameters

    • r: number

      number of failures until experiment is stopped

    • p: number

      success probability

    Returns number

    variance

    Example

    var v = variance( 100, 0.2 );
    // returns 2000.0

    Example

    var v = variance( 20, 0.5 );
    // returns 40.0

    Example

    var v = variance( 10.3, 0.8 );
    // returns ~3.219

    Example

    var v = variance( -2, 0.5 );
    // returns NaN

    Example

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

    Example

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

    Example

    var v = variance( NaN, 0.5 );
    // returns NaN