diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn/README.md index 5be0312c484c..acb3b06bdcc1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn/README.md @@ -166,7 +166,7 @@ console.log( v ); ## See Also - [`@stdlib/blas/ext/base/dapxsumkbn`][@stdlib/blas/ext/base/dapxsumkbn]: add a constant to each double-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm. -- [`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]: add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm. +- [`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]: add a scalar constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm. - [`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]: add a constant to each single-precision floating-point strided array element and compute the sum. - [`@stdlib/blas/ext/base/ssumkbn`][@stdlib/blas/ext/base/ssumkbn]: calculate the sum of single-precision floating-point strided array elements using an improved Kahan–Babuška algorithm. diff --git a/lib/node_modules/@stdlib/constants/float32/pi/README.md b/lib/node_modules/@stdlib/constants/float32/pi/README.md index d09323920e77..ac7408481fde 100644 --- a/lib/node_modules/@stdlib/constants/float32/pi/README.md +++ b/lib/node_modules/@stdlib/constants/float32/pi/README.md @@ -108,6 +108,14 @@ Macro for the mathematical constant [π][pi]. @@ -118,6 +126,16 @@ Macro for the mathematical constant [π][pi]. [pi]: https://en.wikipedia.org/wiki/Pi + + +[@stdlib/constants/float32/fourth-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/fourth-pi + +[@stdlib/constants/float32/half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/half-pi + +[@stdlib/constants/float32/two-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/two-pi + + + 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..9e00b6f73c7e 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,95 @@ 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 an planck distribution. + +```c +double out = stdlib_base_dists_planck_mean( 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 ); + } +} +``` + +
+ + + +
+ + +