Package Exports

compute-erfcinv

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (compute-erfcinv) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

erfcinv

Inverse complementary error function.

Installation

$ npm install compute-erfcinv

For use in the browser, use browserify.

Usage

To use the module,

var erfcinv = require( 'compute-erfcinv' );

The method accepts a single argument: either a single numeric value or an array of numeric values. A value must reside on the interval [0,2]. For an input array, the inverse error function is evaluated for each value.

erfcinv( 0.5 );
erfcinv( [ 0, 0.5, 1, 1.5, 2 ] );

Examples

// Simulate some data...
var data = new Array( 100 );

for ( var i = 0; i < data.length; i++ ) {
    data[ i ] = Math.random() * 2;
}

// Evaluate the inverse complementary error function for each datum:
console.log( erfcinv( data ) );
// returns [...]

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,

$ open reports/coverage/lcov-report/index.html

License

MIT license.

compute-erfcinv