distributions-triangular-cdf v0.0.0
Cumulative Distribution Function
Triangular distribution cumulative distribution function.
The cumulative distribution function for a Triangular random variable is
where a
is the lower limit and b
is the upper limit and c
is the mode.
Installation
$ npm install distributions-triangular-cdf
For use in the browser, use browserify.
Usage
var cdf = require( 'distributions-triangular-cdf' );
cdf( x, options )
Evaluates the cumulative distribution function for the Triangular distribution. x
may be either a number
, an array
, a typed array
, or a matrix
.
var matrix = require( 'dstructs-matrix' ),
mat,
out,
x,
i;
out = cdf( 1 );
// returns 1
out = cdf( -1 );
// returns 0
x = [ 0, 0.2, 0.4, 0.6, 0.8, 1 ];
out = cdf( x );
// returns [ 0, 0.08, 0.32, 0.68, 0.92, 1 ]
x = new Float32Array( x );
out = cdf( x );
// returns Float64Array( [0,0.08,0.32,0.68,0.92,1] )
x = new Float32Array( 6 );
for ( i = 0; i < 6; i++ ) {
x[ i ] = i / 6;
}
mat = matrix( x, [3,2], 'float32' );
/*
[ 0 1/6
2/6 3/6
4/6 5/6 ]
*/
out = cdf( mat );
/*
[ 0 ~0.0556
~0.222 0.5
~0.778 ~0.944 ]
*/
The function accepts the following options
:
- a: lower limit. Default:
0
. - b: upper limit. Default:
1
. - c: mode. Default:
( a + b ) / 2
. __accessor__: accessor `function` for accessing `array` values.
__dtype__: output [`typed array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays) or [`matrix`](https://github.com/dstructs/matrix) 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:
'.'
.
A Triangular distribution is a function of three parameters: a
(lower limit), b
(upper limit) and c
(mode). By default, a
is equal to 0
and b
is equal to 1
and c
is equal to ( a + b ) / 2 = 0.5
. To adjust either parameter, set the corresponding option.
var x = [ -4, -2, 0, 2, 4 ];
var out = cdf( x, {
'a': -3,
'b': 3,
'c': 1
});
// returns [ 0, ~0.0417, ~0.375, ~0.917, 1 ]
For non-numeric arrays
, provide an accessor function
for accessing array
values.
var data = [
[0,0],
[1,0.2],
[2,0.4],
[3,0.6],
[4,0.8],
[5,1]
];
function getValue( d, i ) {
return d[ 1 ];
}
var out = cdf( data, {
'accessor': getValue
});
// returns [ 0, 0.08, 0.32, 0.68, 0.92, 1 ]
To deepset an object array
, provide a key path and, optionally, a key path separator.
var data = [
{'x':[0,0]},
{'x':[1,0.2]},
{'x':[2,0.4]},
{'x':[3,0.6]},
{'x':[4,0.8]},
{'x':[5,1]}
];
var out = cdf( data, {
'path': 'x/1',
'sep': '/'
});
/*
[
{'x':[0,0]},
{'x':[1,0.08]},
{'x':[2,0.32]},
{'x':[3,0.68]},
{'x':[4,0.92]},
{'x':[5,1]},
]
*/
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 x, out;
x = new Float64Array( [0,0.2,0.4,0.6,0.8,1] );
out = cdf( x, {
'dtype': 'float32'
});
// returns Float32Array( [0,0.08,0.32,0.68,0.92,1] )
// Works for plain arrays, as well...
out = cdf( [0,0.2,0.4,0.6,0.8,1], {
'dtype': 'float32'
});
// returns Float32Array( [0,0.08,0.32,0.68,0.92,1] )
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,
x,
i;
x = [ 0, 0.2, 0.4, 0.6, 0.8, 1 ];
out = cdf( x, {
'copy': false
});
// returns [ 0, 0.08, 0.32, 0.68, 0.92, 1 ]
bool = ( x === out );
// returns true
x = new Float32Array( 6 );
for ( i = 0; i < 6; i++ ) {
x[ i ] = i / 6;
}
mat = matrix( x, [3,2], 'float32' );
/*
[ 0 1/6
2/6 3/6
4/6 5/6 ]
*/
out = cdf( mat, {
'copy': false
});
/*
[ 0 ~0.0556
~0.222 0.5
~0.778 ~0.944 ]
*/
bool = ( mat === out );
// returns true
Notes
If an element is not a numeric value, the evaluated cumulative distribution function is
NaN
.var data, out; out = cdf( null ); // returns NaN out = cdf( true ); // returns NaN out = cdf( {'a':'b'} ); // returns NaN out = cdf( [ true, null, [] ] ); // returns [ NaN, NaN, NaN ] function getValue( d, i ) { return d.x; } data = [ {'x':true}, {'x':[]}, {'x':{}}, {'x':null} ]; out = cdf( data, { 'accessor': getValue }); // returns [ NaN, NaN, NaN, NaN ] out = cdf( data, { 'path': 'x' }); /* [ {'x':NaN}, {'x':NaN}, {'x':NaN, {'x':NaN} ] */
Examples
var cdf = require( 'distributions-triangular-cdf' ),
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 / 10;
}
out = cdf( data );
// Object arrays (accessors)...
function getValue( d ) {
return d.x;
}
for ( i = 0; i < data.length; i++ ) {
data[ i ] = {
'x': data[ i ]
};
}
out = cdf( data, {
'accessor': getValue
});
// Deep set arrays...
for ( i = 0; i < data.length; i++ ) {
data[ i ] = {
'x': [ i, data[ i ].x ]
};
}
out = cdf( data, {
'path': 'x/1',
'sep': '/'
});
// Typed arrays...
data = new Float32Array( 10 );
for ( i = 0; i < data.length; i++ ) {
data[ i ] = i / 10;
}
out = cdf( data );
// Matrices...
mat = matrix( data, [5,2], 'float32' );
out = cdf( mat );
// Matrices (custom output data type)...
out = cdf( 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.
8 years ago