time-to-botec/squiggle/node_modules/@stdlib/math/base/special/erf/README.md

erf

Error function.

The error function is defined as

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 );
}