Cumulative Distribution Function
Binomial distribution cumulative distribution function.
Installation
npm install @stdlib/stats-base-dists-binomial-cdf
Usage
var cdf = require( '@stdlib/stats-base-dists-binomial-cdf' );
cdf( x, n, p )
Evaluates the cumulative distribution function for a binomial distribution with number of trials n
and success probability p
.
var y = cdf( 3.0, 20, 0.2 );
y = cdf( 21.0, 20, 0.2 );
y = cdf( 5.0, 10, 0.4 );
y = cdf( 0.0, 10, 0.4 );
If provided NaN
as any argument, the function returns NaN
.
var y = cdf( NaN, 20, 0.5 );
y = cdf( 0.0, NaN, 0.5 );
y = cdf( 0.0, 20, NaN );
If provided a number of trials n
which is not a nonnegative integer, the function returns NaN
.
var y = cdf( 2.0, 1.5, 0.5 );
y = cdf( 2.0, -2.0, 0.5 );
If provided a success probability p
outside of [0,1]
, the function returns NaN
.
var y = cdf( 2.0, 20, -1.0 );
y = cdf( 2.0, 20, 1.5 );
cdf.factory( n, p )
Returns a function for evaluating the cumulative distribution function of a binomial distribution with number of trials n
and success probability p
.
var mycdf = cdf.factory( 10, 0.5 );
var y = mycdf( 3.0 );
y = mycdf( 1.0 );
Examples
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var cdf = require( '@stdlib/stats-base-dists-binomial-cdf' );
var i;
var n;
var p;
var x;
var y;
for ( i = 0; i < 10; i++ ) {
x = randu() * 20.0;
n = round( randu() * 100.0 );
p = randu();
y = cdf( x, n, p );
console.log( 'x: %d, n: %d, p: %d, F(x;n,p): %d', x.toFixed( 4 ), n, p.toFixed( 4 ), y.toFixed( 4 ) );
}
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
![Chat](https://img.shields.io/gitter/room/stdlib-js/stdlib.svg)
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.