diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/cdf/README.md index 061d52fadeef..e3556b53f7a9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/cdf/README.md @@ -129,6 +129,101 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/bernoulli/cdf.h" +``` + +#### stdlib_base_dists_bernoulli_cdf( x, p ) + +Evaluates the [cumulative distribution function][cdf] for a [Bernoulli][bernoulli-distribution] distribution with success probability `p`. + +```c +double y = stdlib_base_dists_bernoulli_cdf( 0.5, 0.5 ); +// returns 0.5 +``` + +The function accepts the following arguments + +- **x**: `[in] double` input value. +- **p**: `[in] double` success probability. + +```c +double stdlib_base_dists_bernoulli_cdf( const double x, const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/bernoulli/cdf.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 p; + double x; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_uniform( 0.0, 5.0 ); + p = random_uniform( 0.0, 1.0 ); + y = stdlib_base_dists_bernoulli_cdf( x, p ); + printf( "x: %lf, p: %lf, F(X;p): %lf\n", x, p, y ); + } +} +``` + +
+ + + +
+ + +