@stdlib/stats-base-dists-negative-binomial-stdev
v0.1.3
Published
Negative binomial distribution standard deviation.
Downloads
5,628
Readme
Standard Deviation
Negative binomial distribution standard deviation.
The standard deviation for a negative binomial random variable is
where r
is the number of successes until experiment is stopped and p
is the success probability in each trial. The random variable X
denotes the number of failures until the r
success is reached.
Installation
npm install @stdlib/stats-base-dists-negative-binomial-stdev
Usage
var stdev = require( '@stdlib/stats-base-dists-negative-binomial-stdev' );
stdev( r, p )
Returns the standard deviation of a negative binomial distribution with parameters r
(number of successes until experiment is stopped) and p
(success probability).
var v = stdev( 100, 0.2 );
// returns ~44.721
v = stdev( 50, 0.5 );
// returns 10.0
If provided NaN
as any argument, the function returns NaN
.
var v = stdev( NaN, 0.5 );
// returns NaN
v = stdev( 20, NaN );
// returns NaN
If provided a r
which is not a positive number, the function returns NaN
.
var v = stdev( -2.0, 0.5 );
// returns NaN
If provided a success probability p
outside of [0,1]
, the function returns NaN
.
var v = stdev( 20, -1.0 );
// returns NaN
v = stdev( 20, 1.5 );
// returns NaN
Examples
var randu = require( '@stdlib/random-base-randu' );
var stdev = require( '@stdlib/stats-base-dists-negative-binomial-stdev' );
var v;
var i;
var r;
var p;
for ( i = 0; i < 10; i++ ) {
r = randu() * 100;
p = randu();
v = stdev( r, p );
console.log( 'r: %d, p: %d, SD(X;r,p): %d', r, p.toFixed( 4 ), v.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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.