@stdlib/math-base-special-erfinv
v0.3.1TypeScript
Inverse error function.
0/weekUpdated yesterdayApache-2.0 AND BSL-1.0Unpacked: 127.4 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-special-erfinvWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
erfinv
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Inverse error function][inverse-error-function].
The [inverse error function][inverse-error-function] is defined in terms of the [Maclaurin series][maclaurin-series]
where c_0 = 1 and
Installation
``bash`
npm install @stdlib/math-base-special-erfinv
Usage
`javascript`
var erfinv = require( '@stdlib/math-base-special-erfinv' );
#### erfinv( x )
Evaluates the [inverse error function][inverse-error-function].
`javascript
var y = erfinv( 0.5 );
// returns ~0.4769
y = erfinv( 0.8 );
// returns ~0.9062
y = erfinv( -1.0 );
// returns -Infinity
y = erfinv( 1.0 );
// returns Infinity
`
The domain of x is restricted to [-1,1]. If |x| > 1, the function returns NaN.
`javascript`
var y = erfinv( -3.14 );
// returns NaN
If provided NaN, the function returns NaN.
`javascript`
var y = erfinv( NaN );
// returns NaN
The [inverse error function][inverse-error-function] is an [odd function][odd-function]; i.e., erfinv(-x) = -erfinv(x). Thus, in accordance with the [IEEE 754][ieee754] standard, if provided -0, the function returns -0.
`javascript`
var y = erfinv( -0.0 );
// returns -0.0
Examples
`javascript
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var erfinv = require( '@stdlib/math-base-special-erfinv' );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -1.0, 1.0, opts );
logEachMap( 'x: %0.4f, erfinv(x): %0.4f', x, erfinv );
`
*
C APIs
$3
`c`
#include "stdlib/math/base/special/erfinv.h"
#### stdlib_base_erfinv( x )
Evaluates the [inverse error function][inverse-error-function].
`c
double out = stdlib_base_erfinv( 0.5 );
// returns ~0.4769
out = stdlib_base_erfinv( 0.8 );
// returns ~0.9062
`
The function accepts the following arguments:
- x: [in] double input value.
`c`
double stdlib_base_erfinv( const double x );
$3
`c
#include "stdlib/math/base/special/erfinv.h"
#include
#include
int main( void ) {
const double x[] = { -1.0, -0.78, -0.56, -0.33, -0.11, 0.11, 0.33, 0.56, 0.78, 1.0 };
double v;
int i;
for ( i = 0; i < 10; i++ ) {
v = stdlib_base_erfinv( x[ i ] );
printf( "x: %lf, erfinv(x): %lf\n", x[ i ], v );
}
}
`
*
See Also
- [@stdlib/math-base/special/erf][@stdlib/math/base/special/erf]: error function.
- [@stdlib/math-base/special/erfc][@stdlib/math/base/special/erfc]: complementary error function.
- [@stdlib/math-base/special/erfcinv][@stdlib/math/base/special/erfcinv]: inverse complementary error function.
*
Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-erfinv.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-erfinv
[test-image]: https://github.com/stdlib-js/math-base-special-erfinv/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/math-base-special-erfinv/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-erfinv/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-erfinv?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/math-base-special-erfinv/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-erfinv/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-erfinv/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-erfinv/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-erfinv/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-erfinv/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-erfinv/blob/main/branches.md
[inverse-error-function]: https://en.wikipedia.org/wiki/Error_function#Inverse_functions
[maclaurin-series]: http://mathworld.wolfram.com/MaclaurinSeries.html
[odd-function]: https://en.wikipedia.org/wiki/Even_and_odd_functions
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
[@stdlib/math/base/special/erf]: https://www.npmjs.com/package/@stdlib/math-base-special-erf
[@stdlib/math/base/special/erfc]: https://www.npmjs.com/package/@stdlib/math-base-special-erfc
[@stdlib/math/base/special/erfcinv]: https://www.npmjs.com/package/@stdlib/math-base-special-erfcinv