diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/mean/README.md index 6f269498f7c8..6e157f700c70 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/mean/README.md @@ -130,6 +130,93 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/bernoulli/mean.h" +``` + +#### stdlib_base_dists_bernoulli_mean( p ) + +Returns the [expected value][expected-value] of a [Bernoulli][bernoulli-distribution] distribution with success probability `p`. + +```c +double out = stdlib_base_dists_bernoulli_mean( 0.1 ); +// returns 0.1 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` success probability. + +```c +double stdlib_base_dists_bernoulli_mean( const double p ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/bernoulli/mean.h" +#include +#include + +int main( void ) { + double p; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + p = (double)rand() / ( (double)RAND_MAX + 1.0 ); + y = stdlib_base_dists_bernoulli_mean( p ); + printf( "x: %lf, E(X;p): %lf\n", p, y ); + } +} +``` + +
+ + + +
+ + +