diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/pdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/levy/pdf/README.md index 9b623c8b0d95..b82fcc416051 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/pdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/pdf/README.md @@ -113,7 +113,7 @@ y = mypdf( 20.0 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var EPS = require( '@stdlib/constants/float64/eps' ); var pdf = require( '@stdlib/stats/base/dists/levy/pdf' ); @@ -124,9 +124,9 @@ var y; var i; for ( i = 0; i < 10; i++ ) { - mu = randu() * 10.0; - x = ( randu()*10.0 ) + mu; - c = ( randu()*10.0 ) + EPS; + mu = uniform( 0.0, 10.0 ); + x = uniform( mu, mu + 10.0 ); + c = uniform( EPS, 10.0 ); y = pdf( x, mu, c ); console.log( 'x: %d, µ: %d, c: %d, f(x;µ,c): %d', x, mu, c, y ); } @@ -136,6 +136,113 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/levy/pdf.h" +``` + +#### stdlib_base_dists_levy_pdf( x, mu, c ) + +Evaluates the [probability density][pdf] for a [Lévy][levy-distribution] distribution with input value `x`, location parameter `mu`, and scale parameter `c`. + +```c +double out = stdlib_base_dists_levy_pdf( 2.0, 0.0, 1.0 ); +// returns ~0.11 +``` + +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_pdf( const double x, const double mu, const double c ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/levy/pdf.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 mu; + double x; + double c; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + mu = random_uniform( 0.0, 10.0 ); + x = random_uniform( mu, mu + 10.0 ); + c = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 ); + y = stdlib_base_dists_levy_pdf( x, mu, c ); + printf( "x: %lf, mu: %lf, c: %lf, f(x;mu,c): %lf\n", x, mu, c, y ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +