@stdlib/stats-base-dists-chisquare-mgf
TypeScript icon, indicating that this package has built-in type declarations

0.0.7 • Public • Published

Moment-Generating Function

NPM version Build Status Coverage Status

Chi-squared distribution moment-generating function (MGF).

The moment-generating function for a chi-squared random variable is

Moment-generating function (MGF) for a chi-squared distribution.

where k is the degrees of freedom.

Installation

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

Usage

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

mgf( t, k )

Evaluates the moment-generating function (MGF) for a chi-squared distribution with degrees of freedom k.

var y = mgf( 0.4, 2 );
// returns ~5.0

y = mgf( -1.0, 5.0 );
// returns ~0.0642

y = mgf( 0.0, 10.0 );
// returns 1.0

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

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

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

If provided t >= 0.5, the function returns NaN.

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

If provided k < 0, the function returns NaN.

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

mgf.factory( k )

Returns a function for evaluating the moment-generating function (MGF) for a chi-squared distribution with degrees of freedom k.

var mymgf = mgf.factory( 1.0 );

var y = mymgf( 0.2 );
// returns ~1.291

y = mymgf( 0.4 );
// returns ~2.236

Examples

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

var t;
var k;
var y;
var i;

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.

Install

npm i @stdlib/stats-base-dists-chisquare-mgf

Homepage

stdlib.io

DownloadsWeekly Downloads

126

Version

0.0.7

License

Apache-2.0

Unpacked Size

42.6 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser