diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/uniform/quantile/README.md index 72bbf832092a..678e73d1f42c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/quantile/README.md @@ -101,7 +101,7 @@ Returns a function for evaluating the quantile function of a [continuous uniform ```javascript var myquantile = quantile.factory( 0.0, 4.0 ); -y = myquantile( 0.8 ); +var y = myquantile( 0.8 ); // returns 3.2 ``` @@ -138,6 +138,100 @@ for ( i = 0; i < 25; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/uniform/quantile.h" +``` + +#### stdlib_base_dists_uniform_quantile( p, a, b ) + +Evaluates the [quantile-function][quantile-function] function for a [continuous uniform][uniform-distribution] distribution with minimum support `a` and maximum support `b` at a probability `p`. + +```c +double out = stdlib_base_dists_uniform_quantile( 0.8, 0.0, 1.0 ); +// returns 0.8 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **a**: `[in] double` minimum support. +- **b**: `[in] double` maximum support. + +```c +double stdlib_base_dists_uniform_quantile( const double p, const double a, const double b ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/uniform/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 a; + double b; + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + a = random_uniform( -20.0, 0.0 ); + b = random_uniform( a, a+40.0 ); + y = stdlib_base_dists_uniform_quantile( p, a, b ); + printf( "p: %lf, a: %lf, b: %lf, Q(p;a,b): %lf\n", p, a, b, y ); + } +} +``` + +
+ + +