diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md index 7603cbad0e47..6869b39890f2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md @@ -161,6 +161,113 @@ for ( i = 0; i < 10; i++ ) { + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/cosine/logcdf.h" +``` + +#### stdlib_base_dists_cosine_logcdf( x, mu, s ) + +Returns the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [raised cosine][cosine-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). + +```c +double out = stdlib_base_dists_cosine_logcdf( 0.5, 0.0, 1.0 ); +// returns ~0.909 +``` + +The function accepts the following arguments: + +- **x**: `[in] int` input value. +- **mu**: `[in] int` location parameter. +- **s**: `[in] int` scale parameter. + +```c +double stdlib_base_dists_cosine_logcdf( const double x, const double mu, const double s ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/cosine/cdf.h" +#include "stdlib/constants/float64/eps.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 s; + double x; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + x = random_uniform( -50.0, 50.0 ); + mu = random_uniform( -50.0, 50.0 ); + s = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS; + y = stdlib_base_dists_cosine_logcdf( x, mu, s ); + printf( "x: %lf, µ: %lf, s: %lf, ln(F(x;µ,s)): %lf\n", x, mu, s , y ); + } + + return 0; +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +