@stdlib/stats-base-dists-cosine-mgf
v0.2.2
Published
Raised cosine distribution moment-generating function (MGF).
Downloads
265
Readme
Moment-generating function
Raised cosine distribution moment-generating function.
The moment-generating function for a raised cosine random variable is
where μ
is the location parameter and s > 0
is the scale parameter.
Installation
npm install @stdlib/stats-base-dists-cosine-mgf
Usage
var mgf = require( '@stdlib/stats-base-dists-cosine-mgf' );
mgf( t, mu, s )
Evaluates the moment-generating function (MGF) for a raised cosine distribution with parameters mu
(location parameter) and s
(scale parameter).
var y = mgf( 2.0, 0.0, 3.0 );
// returns ~7.234
y = mgf( 0.5, 0.0, 1.0 );
// returns ~1.016
y = mgf( -1.0, 4.0, 2.0 );
// returns ~0.024
If provided NaN
as any argument, the function returns NaN
.
var y = mgf( NaN, 0.0, 1.0 );
// returns NaN
y = mgf( 0.0, NaN, 1.0 );
// returns NaN
y = mgf( 0.0, 0.0, NaN );
// returns NaN
If provided s <= 0
, the function returns NaN
.
var y = mgf( 0.5, 0.0, -1.0 );
// returns NaN
y = mgf( 0.5, 0.0, 0.0 );
// returns NaN
mgf.factory( mu, s )
Returns a function for evaluating the moment-generating function of a raised cosine distribution with parameters mu
(location parameter) and s
(scale parameter).
var mymgf = mgf.factory( 10.0, 2.0 );
var y = mymgf( 0.1 );
// returns ~2.725
Examples
var randu = require( '@stdlib/random-base-randu' );
var mgf = require( '@stdlib/stats-base-dists-cosine-mgf' );
var mu;
var s;
var t;
var y;
var i;
for ( i = 0; i < 10; i++ ) {
t = randu() * 10.0;
mu = randu() * 10.0;
s = randu() * 10.0;
y = mgf( t, mu, s );
console.log( 't: %d, µ: %d, s: %d, M_X(t;µ,s): %d', t.toFixed( 4 ), mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
}
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.