diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/pdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/laplace/pdf/README.md index 9ea49b0e069b..b2663dec7a4f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/pdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/pdf/README.md @@ -141,6 +141,99 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/laplace/pdf.h" +``` + +#### stdlib_base_dists_laplace_pdf( mu, b ) + +Evaluates the [probability density function][pdf] (PDF) for a [Laplace][laplace-distribution] distribution with parameters `mu` (location parameter) and `b > 0` (scale parameter). + +```c +double out = stdlib_base_dists_laplace_pdf( 2.0, 0.0, 1.0 ); +// returns ~0.068 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input parameter. +- **mu**: `[in] double` location parameter. +- **b**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_laplace_pdf( const double x, const double mu, const double b ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/laplace/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 b; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + x = random_uniform( 0.0, 10.0 ); + mu = random_uniform( 0.0, 10.0 ); + b = random_uniform( 0.0, 10.0 ); + y = stdlib_base_dists_laplace_pdf( x, mu, b ); + printf("x: %lf, µ: %lf, b: %lf, f(x;µ,b): %lf\n", x, mu, b, y); + } +} +``` + +
+