diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mode/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/mode/README.md index 0d62c5c213a4..8dee74a7ee61 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/mode/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/mode/README.md @@ -118,6 +118,96 @@ for ( i = 0; i < lambda.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/planck/mode.h" +``` + +#### stdlib_base_dists_planck_mode( lambda ) + +Evaluates the mode for planck distribution. + +```c +double out = stdlib_base_dists_planck_mode( 0.1 ); +// returns ~0 +``` + +The function accepts the following arguments: + +- **lambda**: `[in] double` shape parameter + +```c +double stdlib_base_dists_planck_mode( const double lambda ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples +```c +#include "stdlib/stats/base/dists/planck/mode.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 y; + int i; + for ( i = 0; i < 25; i++ ) { + lambda = random_uniform( 0.1, 10.0 ); + y = stdlib_base_dists_planck_mode( lambda ); + printf( "lambda: %lf, E(X;λ): %lf\n", lambda, y ); + } +} +``` + +
+ + + +
+ + +