diff --git a/lib/node_modules/@stdlib/stats/base/dists/poisson/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/poisson/quantile/README.md index 9ee4e34aa050..e9442c156df4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/poisson/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/poisson/quantile/README.md @@ -95,6 +95,13 @@ var y = quantile( 0.4, -1.0 ); // returns NaN ``` +If provided `lambda` equal to `+Infinity`, the function returns `NaN`. + +```javascript +var y = quantile( 0.4, Infinity ); +// returns NaN +``` + If provided `lambda = 0`, the function evaluates the [quantile function][quantile-function] of a [degenerate distribution][degenerate-distribution] centered at `0.0`. ```javascript @@ -149,6 +156,109 @@ logEachMap( 'p: %0.4f, λ: %0.4f, Q(p;λ): %0.4f', p, lambda, quantile ); + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/poisson/quantile.h" +``` + +#### stdlib_base_dists_poisson_quantile( p, lambda ) + +Evaluates the [quantile function][quantile-function] for a [Poisson][poisson-distribution] distribution with mean parameter `lambda` at a probability `p`. + +```c +double out = stdlib_base_dists_poisson_quantile( 0.5, 2.0 ); +// returns 2.0 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input probability. +- **lambda**: `[in] double` mean parameter. + +```c +double stdlib_base_dists_poisson_quantile( const double p, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/poisson/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 lambda; + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + lambda = random_uniform( 0.0, 100.0 ); + y = stdlib_base_dists_poisson_quantile( p, lambda ); + printf( "p: %lf, λ: %lf, Q(p;λ): %lf\n", p, lambda, y ); + } + + return 0; +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +