time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/degenerate/mgf
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

Moment-Generating Function

Degenerate distribution moment-generating function (MGF).

The moment-generating function for a degenerate random variable is

Moment-generating function (MGF) of a degenerate distribution.

where mu is the distribution mean.

Usage

var mgf = require( '@stdlib/stats/base/dists/degenerate/mgf' );

mgf( t, mu )

Evaluates the moment-generating function (MGF) of a degenerate distribution with parameter mu (mean).

var y = mgf( 1.0, 1.0 );
// returns ~2.718

y = mgf( 2.0, 3.0 );
// returns ~403.429

If provided NaN for any argument, the function returns NaN.

var y = mgf( NaN, 0.0 );
// returns NaN

y = mgf( 0.0, NaN );
// returns NaN

mgf.factory( mu )

Returns a function for evaluating the moment-generating function of a degenerate distribution with parameter mu (mean).

var mymgf = mgf.factory( 10.0 );

var y = mymgf( 0.1 );
// returns ~2.718

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var mgf = require( '@stdlib/stats/base/dists/degenerate/mgf' );

var mu;
var t;
var y;
var i;

for ( i = 0; i < 100; i++ ) {
    t = round( randu()*5.0 );
    mu = round( randu()*5.0 );
    y = mgf( t, mu );
    console.log( 'x: %d, µ: %d, M_X(t;µ): %d', t, mu, y );
}