distributions-exponential-mgf
v0.0.0
Published
Exponential distribution moment-generating function (MGF)
Downloads
3
Readme
Moment-Generating Function
Exponential distribution moment-generating function (MGF).
The moment-generating function for an exponential random variable is
where lambda > 0
is the rate parameter. For t >= lambda
, the MGF is undefined and this module returns NaN
.
Installation
$ npm install distributions-exponential-mgf
For use in the browser, use browserify.
Usage
var mgf = require( 'distributions-exponential-mgf' );
mgf( t[, options] )
Evaluates the moment-generating function (MGF) for the exponential distribution. t
may be either a number
, an array
, a typed array
, or a matrix
.
var matrix = require( 'dstructs-matrix' ),
mat,
out,
t,
i;
out = mgf( 0.5 );
// returns 2
out = mgf( -1 );
// returns 0.5
t = [ 0, 0.2, 0.4, 0.6, 0.8, 1 ];
out = mgf( t );
// returns [ 1, 1.25, ~1.667, 2.5, 5, NaN ]
t = new Float32Array( t );
out = mgf( t );
// returns Float64Array( [1,1.25,~1.667,2.5,5,NaN] )
t = new Float32Array( 6 );
for ( i = 0; i < 6; i++ ) {
t[ i ] = i * 0.2;
}
mat = matrix( t, [3,2], 'float32' );
/*
[ 0 0.2
0.4 0.6
0.8 1 ]
*/
out = mgf( mat );
/*
[ 1 1.25
~1.667 2.5
5 NaN ]
*/
The function accepts the following options
:
- lambda: rate parameter. Default:
1
. - accessor: accessor
function
for accessingarray
values. - dtype: output
typed array
ormatrix
data type. Default:float64
. - copy:
boolean
indicating if thefunction
should return a new data structure. Default:true
. - path: deepget/deepset key path.
- sep: deepget/deepset key path separator. Default:
'.'
.
An exponential distribution is a function of one parameter: lambda > 0
(rate parameter). By default, lambda
is equal to 1
. To adjust either parameter, set the corresponding option.
var t = [ 0, 0.5, 1, 1.5, 2, 2.5 ];
var out = mgf( t, {
'lambda': 4
});
// returns [ 1, ~1.143, ~1.333, 1.6, 2, ~2.667 ]
For non-numeric arrays
, provide an accessor function
for accessing array
values.
var data = [
[0,0],
[1,0.5],
[2,1],
[3,1.5],
[4,2],
[5,2.5]
];
function getValue( d, i ) {
return d[ 1 ];
}
var out = mgf( data, {
'accessor': getValue,
'lambda': 4
});
// returns [ 1, ~1.143, ~1.333, 1.6, 2, ~2.667 ]
To deepset an object array
, provide a key path and, optionally, a key path separator.
var data = [
{'x':[0,0]},
{'x':[1,0.5]},
{'x':[2,1]},
{'x':[3,1.5]},
{'x':[4,2]},
{'x':[5,2.5]}
];
var out = mgf( data, {
'path': 'x/1',
'sep': '/',
'lambda': 4
});
/*
[
{'x':[0,1]},
{'x':[1,~1.143]},
{'x':[2,~1.333]},
{'x':[3,1.6]},
{'x':[4,2]},
{'x':[5,~2.667]}
]
*/
var bool = ( data === out );
// returns true
By default, when provided a typed array
or matrix
, the output data structure is float64
in order to preserve precision. To specify a different data type, set the dtype
option (see matrix
for a list of acceptable data types).
var t, out;
t = new Int8Array( [0,1,2,3,4] );
out = mgf( t, {
'dtype': 'int32',
'lambda': 5
});
// returns Int32Array( [1,1,1,2,5] )
// Works for plain arrays, as well...
out = mgf( [0,1,2,3,4], {
'dtype': 'uint8',
'lambda': 5
});
// returns Uint8Array( [1,1,1,2,5] )
By default, the function returns a new data structure. To mutate the input data structure (e.g., when input values can be discarded or when optimizing memory usage), set the copy
option to false
.
var bool,
mat,
out,
t,
i;
t = [ 0, 0.2, 0.4, 0.6, 0.8, 1 ];
out = mgf( t, {
'copy': false
});
// returns [ 1, 1.25, ~1.667, 2.5, 5, NaN ]
bool = ( t === out );
// returns true
t = new Float32Array( 6 );
for ( i = 0; i < 6; i++ ) {
t[ i ] = i * 0.2;
}
mat = matrix( t, [3,2], 'float32' );
/*
[ 0 0.2
0.4 0.6
0.8 1 ]
*/
out = mgf( mat, {
'copy': false
});
/*
[ 1 1.25
~1.667 2.5
5 NaN ]
*/
bool = ( mat === out );
// returns true
Notes
If an element is not a numeric value, the evaluated MGF is
NaN
.var data, out; out = mgf( null ); // returns NaN out = mgf( true ); // returns NaN out = mgf( {'a':'b'} ); // returns NaN out = mgf( [ true, null, [] ] ); // returns [ NaN, NaN, NaN ] function getValue( d, i ) { return d.x; } data = [ {'x':true}, {'x':[]}, {'x':{}}, {'x':null} ]; out = mgf( data, { 'accessor': getValue }); // returns [ NaN, NaN, NaN, NaN ] out = mgf( data, { 'path': 'x' }); /* [ {'x':NaN}, {'x':NaN}, {'x':NaN, {'x':NaN} ] */
Be careful when providing a data structure which contains non-numeric elements and specifying an
integer
output data type, asNaN
values are cast to0
.var out = mgf( [ true, null, [] ], { 'dtype': 'int8' }); // returns Int8Array( [0,0,0] );
Examples
var mgf = require( 'distributions-exponential-mgf' ),
matrix = require( 'dstructs-matrix' );
var data,
mat,
out,
tmp,
i;
// Plain arrays...
data = new Array( 10 );
for ( i = 0; i < data.length; i++ ) {
data[ i ] = i * 0.1;
}
out = mgf( data );
// Object arrays (accessors)...
function getValue( d ) {
return d.x;
}
for ( i = 0; i < data.length; i++ ) {
data[ i ] = {
'x': data[ i ]
};
}
out = mgf( data, {
'accessor': getValue
});
// Deep set arrays...
for ( i = 0; i < data.length; i++ ) {
data[ i ] = {
'x': [ i, data[ i ].x ]
};
}
out = mgf( data, {
'path': 'x/1',
'sep': '/'
});
// Typed arrays...
data = new Float32Array( 10 );
for ( i = 0; i < data.length; i++ ) {
data[ i ] = i * 0.1;
}
out = mgf( data );
// Matrices...
mat = matrix( data, [5,2], 'float32' );
out = mgf( mat );
// Matrices (custom output data type)...
out = mgf( mat, {
'dtype': 'uint8'
});
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015. The Compute.io Authors.