diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md index 0b74b206266b..8f024abef3cb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md @@ -152,6 +152,113 @@ for ( i = 0; i < 10; i++ ) { + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/cosine/logpdf.h" +``` + +#### stdlib_base_dists_cosine_logpdf( x, mu, s ) + +Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [raised cosine][cosine-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). + +```c +double out = stdlib_base_dists_cosine_logpdf( 2.0, 0.0, 3.0 ); +// returns ~-2.485 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. +- **mu**: `[in] double` location parameter. +- **s**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_cosine_logpdf( const double x, const double mu, const double s ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/cosine/logpdf.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( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 ); + y = stdlib_base_dists_cosine_logpdf( x, mu, s ); + printf( "x: %lf, µ: %lf, s: %lf, ln(f(x;µ,s)): %lf\n", x, mu, s , y ); + } + + return 0; +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +