diff --git a/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/README.md index 3824c4525895..4e0eea4f9bb4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/studentized-range/quantile/README.md @@ -124,6 +124,104 @@ logEachMap( 'p: %0.4f, r: %0.4f, v: %0.4f, Q(p;r,v): %0.4f', p, r, v, quantile ) + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/studentized-range/quantile.h" +``` + +#### stdlib_base_dists_studentized_range_quantile( p, r, v ) + +Evaluates the quantile function for a studentized range distribution. + +```c +double out = stdlib_base_dists_studentized_range_quantile( 0.5, 3.0, 2.0 ); +// returns ~1.908 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input probability. +- **r**: `[in] double` sample size for range (same for each group). +- **v**: `[in] double` degrees of freedom. + +```c +double stdlib_base_dists_studentized_range_quantile( const double p, const double r, const double v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/studentized-range/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 r; + double v; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + p = random_uniform( 0.0, 1.0 ); + r = random_uniform( 2.0, 20.0 ); + v = random_uniform( 2.0, 10.0 ); + y = stdlib_base_dists_studentized_range_quantile( p, r, v ); + printf( "p: %lf, r: %lf, v: %lf, Q(p;r,v): %lf\n", p, r, v, y ); + } +} +``` + +
+ + + +
+ + +