@stdlib/stats-base-dists-bernoulli-mgf
v0.3.1
Published
Bernoulli distribution moment-generating function (MGF).
Readme
Moment-Generating Function
Bernoulli distribution moment-generating function (MGF).
The moment-generating function for a Bernoulli random variable is
where 0 <= p <= 1 is the success probability.
Installation
npm install @stdlib/stats-base-dists-bernoulli-mgfUsage
var mgf = require( '@stdlib/stats-base-dists-bernoulli-mgf' );mgf( t, p )
Evaluates the moment-generating function (MGF) of a Bernoulli distribution with success probability p.
var y = mgf( 0.2, 0.5 );
// returns ~1.111
y = mgf( 0.4, 0.5 );
// returns ~1.246If provided NaN as any argument, the function returns NaN.
var y = mgf( NaN, 0.0 );
// returns NaN
y = mgf( 0.0, NaN );
// returns NaNIf provided a success probability p outside of the interval [0,1], the function returns NaN.
var y = mgf( -2.0, -1.0 );
// returns NaN
y = mgf( 0.2, 2.0 );
// returns NaNmgf.factory( p )
Returns a function for evaluating the moment-generating function of a Bernoulli distribution with parameter p (success probability).
var mymgf = mgf.factory( 0.8 );
var y = mymgf( -0.2 );
// returns ~0.855Examples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var mgf = require( '@stdlib/stats-base-dists-bernoulli-mgf' );
var opts = {
'dtype': 'float64'
};
var p = uniform( 25, 0.0, 1.0, opts );
var t = uniform( p.length, -2.0, 2.0, opts );
logEachMap( 't: %0.4f, p: %0.4f, M_X(t;p): %0.4f', t, p, mgf );C APIs
Usage
#include "stdlib/stats/base/dists/bernoulli/mgf.h"stdlib_base_dists_bernoulli_mgf( t, p )
Evaluates the moment-generating function (MGF) of a Bernoulli distribution with success probability p.
double y = stdlib_base_dists_bernoulli_mgf( 0.2, 0.5 );
// returns ~1.111The function accepts the following arguments:
- t:
[in] doubleinput value. - p:
[in] doublesuccess probability.
double stdlib_base_dists_bernoulli_mgf( const double t, const double p );Examples
#include "stdlib/stats/base/dists/bernoulli/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 p;
double t;
double y;
int i;
for ( i = 0; i < 10; i++ ) {
t = random_uniform( -2.0, 2.0 );
p = random_uniform( 0.0, 1.0 );
y = stdlib_base_dists_bernoulli_mgf( t, p );
printf( "t: %lf, p: %lf, M_X(t;p): %lf\n", t, p, 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.
