Package Exports

@stdlib/math-base-special-erf

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 (@stdlib/math-base-special-erf) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

erf

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Error function.

The error function is defined as

$Error function.$

Installation

npm install @stdlib/math-base-special-erf

Usage

var erf = require( '@stdlib/math-base-special-erf' );

erf( x )

Evaluates the error function.

var y = erf( 2.0 );
// returns ~0.9953

y = erf( -1.0 );
// returns ~-0.8427

If provided NaN, the function returns NaN.

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

The error function is an odd function; i.e., erf(-x) = -erf(x). Thus, in accordance with the IEEE 754 standard, if provided -0, the function returns -0.

var y = erf( -0.0 );
// returns -0.0

Examples

var linspace = require( '@stdlib/array-linspace' );
var erf = require( '@stdlib/math-base-special-erf' );

var x = linspace( -10.0, 10.0, 100 );
var y;
var i;

for ( i = 0; i < x.length; i++ ) {
    y = erf( x[ i ] );
    console.log( 'x: %d, erf(x): %d', x[ i ], y );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/math-base-special-erf