diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md index 15a3925528cc..61dca8e2ed69 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md @@ -98,7 +98,7 @@ Returns a `function` for evaluating the logarithm of the [PDF][pdf] (PDF) for a ```javascript var mylogpdf = logpdf.factory( 10.0, 2.0 ); -y = mylogpdf( 10.0 ); +var y = mylogpdf( 10.0 ); // returns ~-1.693 y = mylogpdf( 12.0 ); @@ -148,6 +148,88 @@ for ( i = 0; i < 10; i++ ) { + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/gumbel/logpdf.h" +``` + +#### stdlib_base_dists_gumbel_logcdf( x, mu, beta ) + +Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta > 0` (scale parameter).``` + +```c +double out = stdlib_base_dists_gumbel_logpdf( 0.0, 0.0, 2.0 ); +// returns ~-1.693 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **mu**: `[in] double` location parameter. +- **beta**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_gumbel_logpdf( const double x, const double mu, const double beta ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/gumbel/logpdf.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 beta; + double mu; + double x; + double y; + int i; + + for ( i = 0; i < 25; i++ ) { + x = random_uniform( 0.0, 10.0 ); + mu = random_uniform( 0.0, 10.0 ); + beta = random_uniform( 0.0, 10.0 ); + y = stdlib_base_dists_gumbel_logpdf( x, mu, beta ); + printf( "x: %lf, µ: %lf, β: %lf, ln(f(x;µ,β)): %lf\n", x, mu, beta, y ); + } +} +``` + +
+ + + + + + +