diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/triangular/quantile/README.md index ec2684a0c76d..ab2b432e3395 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/quantile/README.md @@ -158,6 +158,115 @@ for ( i = 0; i < 25; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/triangular/quantile.h" +``` + +#### stdlib_base_dists_triangular_quantile( p, a, b, c ) + +Evaluates the [quantile function][quantile-function] for a [triangular][triangular-distribution] distribution with parameters `a` (lower limit), `b` (upper limit) and `c` (mode). + +```c +double out = stdlib_base_dists_triangular_quantile( 0.9, -1.0, 1.0, 0.0 ); +// returns ~0.553 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input probability. +- **a**: `[in] double` minimum support. +- **b**: `[in] double` maximum support. +- **c**: `[in] double` mode. + +```c +double stdlib_base_dists_triangular_quantile( const double p, const double a, const double b, const double c ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/triangular/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 c; + double p; + double v; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + a = random_uniform( 0.0, 10.0 ); + b = random_uniform( a, a+10.0 ); + c = random_uniform( a, b ); + v = stdlib_base_dists_triangular_quantile( p, a, b, c ); + printf( "p: %lf, a: %lf, b: %lf, c: %lf, Q(p;a,b,c): %lf\n", p, a, b, c, v ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +