diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/weibull/quantile/README.md index 51a7ea37a327..15cea76d65ad 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/quantile/README.md @@ -155,6 +155,105 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/weibull/quantile.h" +``` + +#### stdlib_base_dists_weibull_quantile( p, k, lambda ) + +Evaluates the [quantile function][quantile-function] for a [Weibull][weibull-distribution] distribution with [shape parameter][shape] `k` and [scale parameter][scale] `lambda`. + +```c +double out = stdlib_base_dists_weibull_quantile( 0.5, 1.0, 1.0 ); +// returns ~0.693 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input probability. +- **k**: `[in] double` shape parameter. +- **lambda**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_weibull_quantile( const double p, const double k, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/weibull/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 lambda; + double p; + double k; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + k = random_uniform( 0.1, 5.0 ); + lambda = random_uniform( 0.1, 5.0 ); + y = stdlib_base_dists_weibull_quantile( p, k, lambda ); + printf( "p: %lf, k: %lf, lambda: %lf, Q(p;k,lambda): %lf\n", p, k, lambda, y ); + } + return 0; +} +``` + +
+ + + +
+ + +