diff --git a/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/README.md index 513f1d484eb0..4a09ff17f464 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/README.md @@ -124,6 +124,94 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/poisson/mean.h" +``` + +#### stdlib_base_dists_poisson_mean( λ ) + +Returns the [expected value][expected-value] of a [Poisson][poisson-distribution] distribution with mean parameter `λ`. + +```c +double out = stdlib_base_dists_poisson_mean( 0.5 ); +// returns 0.5 +``` + +The function accepts the following arguments: + +- **λ**: `[in] double` mean parameter. + +```c +double stdlib_base_dists_poisson_mean( const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/poisson/mean.h" +#include +#include + +int main( void ) { + double lambda; + double v; + int i; + + for ( i = 0; i < 10; i++ ) { + lambda = 20.0 * (double)rand() / ( (double)RAND_MAX + 1.0 ); + v = stdlib_base_dists_poisson_mean( lambda ); + printf( "λ: %lf , E(X;λ): %lf\n", lambda , v ); + } +} +``` + +
+ + + +
+ + +