diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md index ed3daca7c5be..56abe006a7cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/quantile/README.md @@ -145,6 +145,109 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/bernoulli/quantile.h" +``` + +#### stdlib_base_dists_bernoulli_quantile( r, p ) + +Evaluates the [quantile][quantile-function] of a [Bernoulli][bernoulli-distribution] distribution with input value `r` and success probability `p`. + +```c +double out = stdlib_base_dists_bernoulli_quantile( 0.8, 0.4 ); +// returns 1 +``` + +The function accepts the following arguments: + +- **r**: `[in] double` input value. +- **p**: `[in] double` success probability. + +```c +double stdlib_base_dists_bernoulli_quantile( const double r, const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/bernoulli/quantile.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 r; + double p; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + r = random_uniform( 0.0, 1.0 ); + p = random_uniform( 0.0, 1.0 ); + y = stdlib_base_dists_bernoulli_quantile( r, p ); + printf( "r: %lf, p: %lf, Q(r;p): %lf\n", r, p, y ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +