diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md index ad7a3d74bb89..932be10878c0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md @@ -135,6 +135,113 @@ for ( i = 0; i < 10; i++ ) { + + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/cosine/mgf.h" +``` + +#### stdlib_base_dists_cosine_mgf( t, mu, s ) + +Returns the [moment-generating function][mgf] (MGF) for a [raised cosine][cosine-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). + +```c +double out = stdlib_base_dists_cosine_mgf( 0.5, 0.0, 1.0 ); +// returns ~1.016 +``` + +The function accepts the following arguments: + +- **t**: `[in] double` input value. +- **mu**: `[in] double` location parameter. +- **s**: `[in] double` scale parameter. + +```c +double stdlib_base_dists_cosine_mgf( const double t, const double mu, const double s ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/cosine/mgf.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 t; + double y; + int i; + + for ( i = 0; i < 10; i++ ) { + t = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 ); + mu = random_uniform( -50.0, 50.0 ); + s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 ); + y = stdlib_base_dists_cosine_mgf( t, mu, s ); + printf( "t: %lf, µ: %lf, s: %lf, M_X(t;µ,s): %lf\n", t, mu, s , y ); + } + + return 0; +} +``` + +
+ + + +
+ + + + + +
+ +
+ + +