time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/binomial/variance
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

Variance

Binomial distribution variance.

The variance for a binomial random variable is

Variance for a binomial distribution.

where n is the number of trials and p is the success probability.

Usage

var variance = require( '@stdlib/stats/base/dists/binomial/variance' );

variance( n, p )

Returns the variance of a binomial distribution with number of trials n and success probability p.

var v = variance( 20, 0.1 );
// returns 1.8

v = variance( 50, 0.5 );
// returns 12.5

If provided NaN as any argument, the function returns NaN.

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

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

If provided a number of trials n which is not a nonnegative integer, the function returns NaN.

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

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

If provided a success probability p outside of [0,1], the function returns NaN.

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

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

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var variance = require( '@stdlib/stats/base/dists/binomial/variance' );

var v;
var i;
var n;
var p;

for ( i = 0; i < 10; i++ ) {
    n = round( randu() * 100.0 );
    p = randu();
    v = variance( n, p );
    console.log( 'n: %d, p: %d, Var(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
}