diff --git a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/cdf/README.md index 7ba76130cc32..638edf3c4e64 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/negative-binomial/cdf/README.md @@ -156,6 +156,113 @@ logEachMap( 'x: %0.4f, r: %0.4f, p: %0.4f, F(x;r,p): %0.4f', x, r, p, cdf ); + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/negative-binomial/cdf.h" +``` + +#### stdlib_base_dists_negative_binomial_cdf( x, r, p ) + +Evaluates the [cumulative distribution function][cdf] (CDF) for a [negative binomial][negative-binomial-distribution] distribution with number of successes until experiment is stopped `r` and success probability `p` at a value `x`. + +```c +double out = stdlib_base_dists_negative_binomial_cdf( 5.0, 20.0, 0.8 ); +// returns ~0.617 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **r**: `[in] double` number of successes until experiment is stopped. +- **p**: `[in] double` success probability. + +```c +double stdlib_base_dists_negative_binomial_cdf( const double x, const double r, const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/negative-binomial/cdf.h" +#include "stdlib/math/base/special/ceil.h" +#include +#include + +static double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v * (max - min) ); +} + +int main( void ) { + double x; + double r; + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + x = random_uniform( 0.0, 40.0 ); + r = stdlib_base_ceil( random_uniform( 1.0, 100.0 ) ); + p = random_uniform( 0.0, 1.0 ); + y = stdlib_base_dists_negative_binomial_cdf( x, r, p ); + printf( "x: %lf, r: %lf, p: %lf, F(x;r,p): %lf\n", x, r, p, y ); + } + + return 0; +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +