diff --git a/lib/node_modules/@stdlib/stats/base/dists/lognormal/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/lognormal/quantile/README.md index 1deef67ca171..c6ffd81f0fcc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/lognormal/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/lognormal/quantile/README.md @@ -55,7 +55,7 @@ var quantile = require( '@stdlib/stats/base/dists/lognormal/quantile' ); #### quantile( p, mu, sigma ) -Evaluates the [quantile function][quantile-function] for a [lognormal][lognormal-distribution] distribution with parameters `mu` (location parameter) and `sigma` (scale parameter). +Evaluates the [quantile function][quantile-function] for a [lognormal][lognormal-distribution] distribution with parameters `mu` (location parameter) and `sigma` (scale parameter) at a probability `p`. ```javascript var y = quantile( 0.5, 0.0, 1.0 ); @@ -147,6 +147,105 @@ logEachMap( 'p: %0.4f, µ: %0.4f, σ: %0.4f, Q(p;µ,σ): %0.4f', p, mu, sigma, q + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/lognormal/quantile.h" +``` + +#### stdlib_base_dists_lognormal_quantile( p, mu, sigma ) + +Evaluates the [quantile function][quantile-function] for a [lognormal][lognormal-distribution] distribution with parameters `mu` (location parameter) and `sigma` (scale parameter) at a probability `p`. + +```c +double y = stdlib_base_dists_lognormal_quantile( 0.84, -1.05, 15.66 ); +// returns ~2045394.34 +``` + +The function accepts the following arguments: + +- **p**: `[in] double` input value(Probability). +- **mu**: `[in] double` location parameter. +- **sigma**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_lognormal_quantile( const double p, const double mu, const double sigma ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/lognormal/quantile.h" +#include "stdlib/constants/float64/eps.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 sigma; + double mu; + double p; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + p = random_uniform( 0.0, 1.0 ); + mu = random_uniform( -5.0, 5.0 ); + sigma = random_uniform( 0.0, 20.0 ); + y = stdlib_base_dists_lognormal_quantile( p, mu, sigma ); + printf( "p: %lf, μ: %lf, σ: %lf, Q(p;μ,σ): %lf\n", p, mu, sigma, y ); + } +} +``` + +
+ + + +
+ + +