diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/README.md index b1b41f6e1baf..024053af5ae4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/README.md @@ -114,6 +114,102 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/degenerate/logcdf.h" +``` + +#### stdlib_base_dists_degenerate_logcdf( x, mu ) + +Evaluates the natural logarithm of the [CDF][cdf] of a [degenerate distribution][degenerate-distribution] centered at `mu`. + +```c +double y = stdlib_base_dists_degenerate_logcdf( 2.0, 3.0 ); +// returns -Infinity +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **mu**: `[in] double` constant value of distribution. + +```c +double stdlib_base_dists_degenerate_logcdf( const double x, const double mu ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/degenerate/logcdf.h" +#include "stdlib/math/base/special/round.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 y; + int i; + + for ( i = 0; i < 10; i++ ) { + x = stdlib_base_round( random_uniform( 0.0, 10.0 ) ); + mu = stdlib_base_round( random_uniform( 0.0, 10.0 ) ); + y = stdlib_base_dists_degenerate_logcdf( x, mu ); + printf( "x: %lf, µ: %lf, ln(F(x;µ)): %lf\n", x, mu, y ); + } +} +``` + +
+ + + +
+ + +