diff --git a/lib/node_modules/@stdlib/stats/base/dists/invgamma/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/invgamma/quantile/README.md index feafe97f0993..1360ab5bbba8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/invgamma/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/invgamma/quantile/README.md @@ -55,7 +55,7 @@ var quantile = require( '@stdlib/stats/base/dists/invgamma/quantile' ); #### quantile( p, alpha, beta ) -Evaluates the [quantile function][quantile-function] for an [inverse gamma][inverse-gamma] distribution with parameters `alpha` (shape parameter) and `beta` (rate parameter). +Evaluates the [quantile function][quantile-function] for an [inverse gamma][inverse-gamma] distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter). ```javascript var y = quantile( 0.8, 2.0, 1.0 ); @@ -104,7 +104,7 @@ var y = quantile( 0.4, 1.0, -1.0 ); #### quantile.factory( alpha, beta ) -Returns a function for evaluating the [quantile function][quantile-function] of an [inverse gamma][inverse-gamma] distribution with parameters `alpha` (shape parameter) and `beta` (rate parameter). +Returns a function for evaluating the [quantile function][quantile-function] of an [inverse gamma][inverse-gamma] distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter). ```javascript var myquantile = quantile.factory( 2.0, 2.0 ); @@ -144,6 +144,104 @@ logEachMap( 'p: %0.4f, α: %0.4f, β: %0.4f, Q(p;α,β): %0.4f', p, alpha, beta, +* * * + + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/invgamma/quantile.h" +``` + +#### stdlib_base_dists_invgamma_quantile( p, alpha, beta ) + +Evaluates the [quantile function][quantile-function] for an [inverse gamma][inverse-gamma] distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter). + +```c +double y = stdlib_base_dists_invgamma_quantile( 0.8, 2.0, 1.0 ); +// returns ~1.213 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input value. +- **alpha**: `[in] double` shape parameter. +- **beta**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_invgamma_quantile( const double p, const double alpha, const double beta ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/invgamma/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 alpha; + double beta; + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + alpha = random_uniform( 1.0, 10.0 ); + beta = random_uniform( 1.0, 10.0 ); + y = stdlib_base_dists_invgamma_quantile( p, alpha, beta ); + printf( "p: %lf, α: %lf, β: %lf, Q(p;α,β): %lf\n", p, alpha, beta, y ); + } +} +``` + +
+ + + +
+ + +