math-erfcinv
v1.0.0
Published
Inverse complementary error function.
Downloads
20
Maintainers
Readme
erfcinv
The inverse complementary error function is defined as
where erf^{-1}(z)
is the inverse error function.
Installation
$ npm install math-erfcinv
Usage
var erfcinv = require( 'math-erfcinv' );
erfcinv( x )
Evaluates the inverse complementary error function.
var y = erfcinv( 0.5 );
// returns ~0.4769
y = erfcinv( 0.8 );
// returns ~0.1791
y = erfcinv( 0 );
// returns +infinity
y = erfcinv( 2 );
// returns -infinity
The domain of x
is restricted to [0,2]
. If x
is outside this interval, the function
will throw a RangeError
.
var y = erfcinv( -3.14 );
// throws <Error>
If provided NaN
, the function
returns NaN
.
var y = erfcinv( NaN );
// returns NaN
Examples
var linspace = require( 'compute-linspace' );
var erfcinv = require( 'math-erfcinv' );
var x = linspace( 0, 2, 100 );
var y;
var i;
for ( i = 0; i < x.length; i++ ) {
y = erfcinv( x[ i ] );
console.log( 'x: %d, erfcinv(x): %d', x[ i ], y );
}
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
This repository uses tape for unit tests. 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
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. The Compute.io Authors.