diff --git a/lib/node_modules/@stdlib/stats/base/dists/poisson/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/poisson/logpmf/README.md index e8cb1e0f0695..ed7db89435fb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/poisson/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/poisson/logpmf/README.md @@ -143,6 +143,101 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/poisson/logpmf.h" +``` + +#### stdlib_base_dists_poisson_logpmf( x, lambda ) + +Evaluates the natural logarithm of the [probability mass function][pmf] (PMF) for a [Poisson][poisson-distribution] distribution with mean parameter `lambda`. + +```c +double out = stdlib_base_dists_poisson_logpmf( 4.0, 3.0 ); +// returns ~-1.784 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **lambda**: `[in] double` mean parameter. + +```c +double stdlib_base_dists_poisson_logpmf( const double x, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/poisson/logpmf.h" +#include "stdlib/random/base/ceil.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 lambda; + double x; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + x = stdlib_base_ceil( random_uniform( 0.0, 10.0 ) ); + lambda = random_uniform( 0.0, 10.0); + y = stdlib_base_dists_poisson_logpmf( x, lambda ); + printf( "x: %lf, λ: %lf, ln(P(X=x;λ)): %lf\n", x, lambda, y ); + } +} +``` + +
+ + + +
+ + +