diff --git a/lib/node_modules/@stdlib/stats/base/dists/erlang/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/erlang/quantile/README.md index d4c7c4321708..bf11d6fba232 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/erlang/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/erlang/quantile/README.md @@ -158,6 +158,89 @@ logEachMap( 'p: %0.4f, k: %d, λ: %0.4f, Q(p;k,λ): %0.4f', p, k, lambda, quanti + + +
+ +
+ +
+ + + + +
+ +## C APIs + +### Usage + +```c +#include "stdlib/stats/base/dists/erlang/quantile.h" +``` + +#### stdlib_base_dists_erlang_quantile( p, k, lambda ) + +Evaluates the [quantile function][quantile-function] for an [Erlang][erlang-distribution] distribution with shape parameter `k` and rate parameter `lambda`. + +```c +double out = stdlib_base_dists_erlang_quantile( 0.8, 2.0, 1.0 ); +// returns ~2.994 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input probability. +- **k**: `[in] double` shape parameter. +- **lambda**: `[in] double` rate parameter. + +```c +double stdlib_base_dists_erlang_quantile( const double p, const double k, const double lambda ); +``` + +
+ + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/erlang/quantile.h" +#include +#include + +static double random_uniform( double min, double max ) { + double scale = rand() / (double) RAND_MAX; + return min + ( scale * ( max - min ) ); +} + +int main( void ) { + double lambda; + double p; + double y; + int k; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + k = (int)random_uniform( 1.0, 10.0 ); + lambda = random_uniform( 0.1, 5.0 ); + y = stdlib_base_dists_erlang_quantile( p, (double)k, lambda ); + printf( "p: %lf, k: %d, λ: %lf, Q(p;k,λ): %lf\n", p, k, lambda, y ); + } +} +``` + +
+ + + +
+ + +