diff --git a/lib/node_modules/@stdlib/stats/base/dists/poisson/pmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/poisson/pmf/README.md index 78b9905b2073..a00d94f8eb9b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/poisson/pmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/poisson/pmf/README.md @@ -143,6 +143,97 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/poisson/pmf.h" +``` + +#### stdlib_base_dists_poisson_pmf( x, λ ) + +Evaluates the probability mass function (PMF) for a Poisson distribution with mean parameter `lambda` at a value `x`. + +```c +double y = stdlib_base_dists_poisson_pmf( 4.0, 3.0 ); +* // returns ~0.168 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **λ**: `[in] double` mean parameter. + +```c +double stdlib_base_dists_poisson_pmf( const double x, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/poisson/pmf.h" +#include +#include + +int main( void ) { + double x; + double lambda; + double v; + int i; + + for ( i = 0; i < 10; i++ ) { + x = 20.0 * (double)rand() / ( (double)RAND_MAX + 1.0 ); + lambda = 20.0 * (double)rand() / ( (double)RAND_MAX + 1.0 ); + v = stdlib_base_dists_poisson_pmf( x, lambda ); + printf( "x: %lf, λ: %lf , E(X;λ): %lf\n", x, lambda , v ); + } +} +``` + +
+ + + +
+ + +