diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md index d88ee8a4a413..91b1573217d1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/README.md @@ -110,6 +110,101 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/degenerate/quantile.h" +``` + +#### stdlib_base_dists_degenerate_quantile( p, mu ) + +Evaluates the [quantile function][quantile-function] of a [degenerate distribution][degenerate-distribution] centered at `mu`. + +```c +double out = stdlib_base_dists_degenerate_quantile( 0.5, 2.0 ); +// returns 2.0 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input value (probability). +- **mu**: `[in] double` constant value of the distribution. + +```c +double stdlib_base_dists_degenerate_quantile( const double p, const double mu ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/degenerate/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 result; + double mu; + double p; + int i; + + for ( i = 0; i < 10; i++ ) { + p = random_uniform( 0.0, 1.0 ); + mu = random_uniform( -20.0, 20.0 ); + result = stdlib_base_dists_degenerate_quantile( p, mu ); + printf( "p: %lf, µ: %lf, Q(p;µ): %lf \n", p, mu, result ); + } +} +``` + +
+ + + +
+ + +