Cumulative Distribution Function

Rayleigh distribution cumulative distribution function.

The cumulative distribution function for a Rayleigh random variable is

where sigma is the scale parameter.

Installation

$ npm install distributions-rayleigh-cdf

For use in the browser, use browserify.

Usage

var cdf = require( 'distributions-rayleigh-cdf' );

cdf( x[, options] )

Evaluates the cumulative distribution function for the Rayleigh 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 ~0.393

x = [ -1, 0, 1, 2, 3 ];
out = cdf( x );
// returns [ 0, 0, ~0.393, ~0.865, ~0.989 ]

x = new Float32Array( x );
out = cdf( x );
// returns Float64Array( [0,0,~0.393,~0.865,~0.989] )

x = new Float32Array( 6 );
for ( i = 0; i < 6; i++ ) {
	x[ i ] = i;
}
mat = matrix( x, [3,2], 'float32' );
/*
	[ 0 1
	  2 3
	  3 5 ]
*/

out = cdf( mat );
/*
	[ 0     ~0.393
	 ~0.865 ~0.989
	 ~1     ~1    ]
*/

The function accepts the following options:

• sigma: scale parameter. Default: 1.
• accessor: accessor function for accessing array values.
• dtype: output typed array or matrix data type. Default: float64.
• copy: boolean indicating if the function should return a new data structure. Default: true.
• path: deepget/deepset key path.
• sep: deepget/deepset key path separator. Default: '.'.

A Rayleigh distribution is a function of one parameter: sigma(scale parameter). By default, sigma is equal to 1. To adjust it, set the corresponding option.

var x = [ -1, 0, 1, 2, 3 ];

var out = cdf( x, {
	'sigma': 7
});
// returns [ 0, 0, ~0.0102, ~0.04, ~0.0877 ]

For non-numeric arrays, provide an accessor function for accessing array values.

var data = [
	[0,-1],
	[1,0],
	[2,1],
	[3,2],
	[4,3],
];

function getValue( d, i ) {
	return d[ 1 ];
}

var out = cdf( data, {
	'accessor': getValue
});
// returns [ 0, 0, ~0.393, ~0.865, ~0.989 ]

To deepset an object array, provide a key path and, optionally, a key path separator.

var data = [
	{'x':[0,-4]},
	{'x':[1,-2]},
	{'x':[2,0]},
	{'x':[3,2]},
	{'x':[4,4]},
];

var out = cdf( data, {
	'path': 'x/1',
	'sep': '/'
});
/*
	[
		{'x':[0,0]},
		{'x':[1,0]},
		{'x':[2,~0.393]},
		{'x':[3,~0.865]},
		{'x':[4,~0.989]},
	]
*/

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( [-1,0,1,2,3] );

out = cdf( x, {
	'dtype': 'float32'
});
// returns Float32Array( [0,0,~0.393,~0.865,~0.989] )

// Works for plain arrays, as well...
out = cdf( [-1,0,1,2,3], {
	'dtype': 'float32'
});
// returns Float32Array( [0,0,~0.393,~0.865,~0.989] )

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 = [ -1, 0, 1, 2, 3 ];

out = cdf( x, {
	'copy': false
});
// returns [ 0, 0, ~0.0102, ~0.04, ~0.0877 ]

bool = ( x === out );
// returns true

x = new Float32Array( 6 );
for ( i = 0; i < 6; i++ ) {
	x[ i ] = i;
}
mat = matrix( x, [3,2], 'float32' );
/*
	[ 0 1
	  2 3
	  3 5 ]
*/


out = cdf( mat, {
	'copy': false
});
/*
	[ 0     ~0.393
	 ~0.865 ~0.989
	 ~1     ~1    ]
*/

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-rayleigh-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 / 2;
}
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 / 2;
}
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

MIT license.

Copyright

Copyright © 2015. The Compute.io Authors.