@stdlib/stats-base-dists-poisson-mgf

Moment-Generating Function

Poisson distribution moment-generating function (MGF).

The moment-generating function for a Poisson random variable is

where lambda > 0 is the mean parameter.

Installation

npm install @stdlib/stats-base-dists-poisson-mgf

Usage

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

mgf( t, lambda )

Evaluates the moment-generating function (MGF) for a Poisson distribution with parameter lambda (mean).

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

y = mgf( 0.5, 0.5 );
// returns ~1.383

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

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

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

If provided lambda <= 0, the function returns NaN.

var y = mgf( -2.0, -1.0 );
// returns NaN

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

mgf.factory( lambda )

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

var mymgf = mgf.factory( 2.0 );
var y = mymgf( 0.1 );
// returns ~1.234

Examples

var randu = require( '@stdlib/random-base-randu' );
var mgf = require( '@stdlib/stats-base-dists-poisson-mgf' );

var lambda;
var t;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    t = randu() * 5.0;
    lambda = randu() * 5.0;
    y = mgf( t, lambda );
    console.log( 'x: %d, λ: %d, M_X(t;λ): %d', t.toFixed( 4 ), lambda.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.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.1 (2021-06-15)

No changes reported for this release.

</section> <!-- /.release -->