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

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Moment-Generating Function

Gamma distribution moment-generating function (MGF).

The moment-generating function for a gamma random variable is

where alpha is the shape parameter and beta is the rate parameter. For t >= beta, the MGF is not defined.

Installation

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

Usage

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

mgf( t, alpha, beta )

Evaluates the moment-generating function (MGF) for a gamma distribution with parameters alpha (shape parameter) and beta (rate parameter).

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

y = mgf( 0.1, 1.0, 1.0 );
// returns ~1.111

y = mgf( -1.0, 4.0, 2.0 );
// returns ~0.198

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

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

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

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

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

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

If provided alpha < 0, the function returns NaN.

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

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

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

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

mgf.factory( alpha, beta )

Returns a function for evaluating the MGF of a gamma distribution with parameters alpha (shape parameter) and beta (rate parameter).

var mymgf = mgf.factory( 3.0, 1.5 );

var y = mymgf( 1.0 );
// returns ~27.0

y = mymgf( 0.5 );
// returns ~3.375

Examples

var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var mgf = require( '@stdlib/stats-base-dists-gamma-mgf' );

var opts = {
    'dtype': 'float64'
};
var t = uniform( 10, 0.0, 3.0, opts );
var alpha = uniform( 10, 0.0, 5.0, opts );
var beta = uniform( 10, 0.0, 5.0, opts );

logEachMap( 't: %0.4f, α: %0.4f, β: %0.4f, M_X(t;α,β): %0.4f', t, alpha, beta, mgf );

---

C APIs

Usage

#include "stdlib/stats/base/dists/gamma/mgf.h"

stdlib_base_dists_gamma_mgf( t, alpha, beta )

Evaluates the moment-generating function (MGF) for a gamma distribution with parameters alpha (shape parameter) and beta (rate parameter).

double y = stdlib_base_dists_gamma_mgf( 0.5, 0.5, 1.0 );
// returns ~1.414

The function accepts the following arguments:

• t: [in] double input value.
• alpha: [in] double shape parameter.
• beta: [in] double rate parameter.

double stdlib_base_dists_gamma_mgf( const double t, const double alpha, const double beta );

Examples

#include "stdlib/stats/base/dists/gamma/mgf.h"
#include <stdlib.h>
#include <stdio.h>

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 alpha;
    double beta;
    double t;
    double y;
    int i;

    for ( i = 0; i < 10; i++ ) {
        t = random_uniform( 0.0, 3.0 );
        alpha = random_uniform( 0.0, 5.0 );
        beta = random_uniform( 0.0, 5.0 );
        y = stdlib_base_dists_gamma_mgf( t, alpha, beta );
        printf( "t: %lf, α: %lf, β: %lf, M_X(t;α,β): %lf\n", t, alpha, beta, y );
    }
}

---

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-2026. The Stdlib Authors.