diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/levy/cdf/README.md index 1807a0c949b7..861f7df2b21a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/cdf/README.md @@ -139,6 +139,104 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/levy/cdf.h" +``` + +#### stdlib_base_dists_levy_cdf( x, mu, c ) + +Evaluates the [cumulative distribution function][cdf] (CDF) for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c > 0` (scale parameter). + +```c +double out = stdlib_base_levy_cdf( 0.5, 0.0, 2.0 ); +// returns ~0.520 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **mu**: `[in] double` location parameter. +- **c**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_levy_cdf( const double x, const double mu, const double c ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/levy/cdf.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 x; + double mu; + double c; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + x = random_uniform( -10.0, 10.0 ); + mu = random_uniform( -20.0, 0.0 ); + c = random_uniform( 0.1, 10.0 ); + y = stdlib_base_dists_levy_cdf( x, mu, c ); + printf( "x: %lf, mu: %lf, c: %lf, F(x;mu,c): %lf\n", x, mu, c, y ); + } +} +``` + +
+ + + +
+ + +