math-erfc

1.0.0 • Public • Published

erfc

NPM version Build Status Coverage Status Dependencies

Complementary error function.

The complementary error function is defined as

Complementary error function.

The complementary error function can also be expressed using Craig's formula

Craig's formula of the complementary error function.

Installation

$ npm install math-erfc

Usage

var erfc = require( 'math-erfc' );

erfc( x )

Evaluates the complementary error function.

var y = erfc( 2 );
// returns ~0.0047
 
= erfc( -1 );
// returns ~1.8427
 
= erfc( Number.POSITIVE_INFINITY );
// returns 0
 
= erfc( Number.NEGATIVE_INFINITY );
// returns 2

If provided NaN, the function returns NaN.

var y = erfc( NaN );
// returns NaN

Examples

var linspace = require( 'compute-linspace' );
var erfc = require( 'math-erfc' );
 
var x = linspace( -10, 10, 100 );
var y;
var i;
 
for ( i = 0; i < x.length; i++ ) {
    y = erfc( x[ i ] );
    console.log( 'x: %d, erfc(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

MIT license.

Copyright

Copyright © 2016. The Compute.io Authors.

Dependencies (5)

Dev Dependencies (10)

Package Sidebar

Install

npm i math-erfc

Weekly Downloads

90

Version

1.0.0

License

MIT

Last publish

Collaborators

  • kgryte