diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/pdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/weibull/pdf/README.md index bf56f41bb475..34696980dc35 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/pdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/pdf/README.md @@ -145,6 +145,104 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/weibull/pdf.h" +``` + +#### stdlib_base_dists_weibull_pdf( x, k, lambda ) + +Evaluates the [probability density function][pdf] (PDF) for a [Weibull][weibull-distribution] distribution with [shape parameter][shape] `k` and [scale parameter][scale] `lambda`. + +```c +double out = stdlib_base_dists_weibull_pdf( 2.0, 1.0, 1.0 ); +// returns ~0.037 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **k**: `[in] double` scale parameter. +- **lambda**: `[in] double` shape parameter. + +```c +double stdlib_base_dists_weibull_pdf( const double x, const double k, const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/weibull/pdf.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 x; + double k; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + x = random_uniform( 0.0, 10.0 ); + lambda = random_uniform( 0.0, 10.0 ); + k = random_uniform( 0.0, 10.0 ); + y = stdlib_base_dists_weibull_pdf( x, k, lambda ); + printf( "x: %lf, k: %lf, λ: %lf, f(x;k,λ): %lf\n", x, k, lambda, y ); + } +} +``` + +
+ + + +
+ + +