diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/logistic/quantile/README.md index 9e02846fa14c..5d655213f327 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/quantile/README.md @@ -152,6 +152,100 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/logistic/quantile.h" +``` + +#### stdlib_base_dists_logistic_quantile( p, mu, s ) + +Returns the quantile for a logistic distribution with probability `p`, location `mu` and scale `s`. + +```c +double out = stdlib_base_dists_logistic_quantile( 0.8, 0.0, 1.0 ); +// returns ~1.386 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` probability parameter. +- **mu**: `[in] double` location parameter. +- **s**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_logistic_quantile( const double p, const double mu, const double s ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/logistic/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 mu; + double p; + double s; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + mu = random_uniform( -5.0, 5.0 ); + s = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_logistic_quantile( p, mu, s ); + printf( "p:: %lf, µ:: %lf, s: %lf, Q(p;µ,s): %lf\n", p, mu, s, y ); + } +} +``` + +
+ + +