diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/README.md index eff820a35c03..0900b91b56b0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/betaprime/quantile/README.md @@ -156,6 +156,103 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/betaprime/quantile.h" +``` + +#### stdlib_base_dists_betaprime_quantile( p, alpha, beta ) + +Returns the [quantile function][quantile-function] for a [beta prime][betaprime-distribution] distribution with parameters `alpha` (first shape parameter) and `beta` (second shape parameter) with provided a probability `p`. + +```c +double x = stdlib_base_dists_betaprime_quantile( 1.1, 1.0, 1.0 ); +// returns NaN +``` + +The function accepts the following arguments: + +- **p**: `[in] double` probability. +- **alpha**: `[in] double` first shape parameter. +- **beta**: `[in] double` second shape parameter. + +```c +double stdlib_base_dists_betaprime_quantile( const double p, const double alpha, const double beta ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/betaprime/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 p; + double alpha; + double beta; + double y; + int i; + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0, 10.0 ); + alpha = random_uniform( 0, 10.0 ); + beta = random_uniform( 0, 10.0 ); + y = stdlib_base_dists_betaprime_quantile( p, a, b ); + printf( "p: %lf, α: %lf, β: %lf, Q(p;α,β): %lf", p, α, β, y ); + } +} +``` + +
+ + + +
+ + +