@stdlib/math-base-special-erfcinv
v0.2.4TypeScript
Inverse complementary error function.
0/weekUpdated yesterdayApache-2.0 AND BSL-1.0Unpacked: 104.0 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-special-erfcinvWe 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...
erfcinv
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Inverse complementary error function][erfcinv].
The [inverse complementary error function][erfcinv] is defined as
where erf^{-1}(z) is the [inverse error function][@stdlib/math/base/special/erfinv].
Installation
``bash`
npm install @stdlib/math-base-special-erfcinv
Usage
`javascript`
var erfcinv = require( '@stdlib/math-base-special-erfcinv' );
#### erfcinv( x )
Evaluates the [inverse complementary error function][erfcinv].
`javascript
var y = erfcinv( 0.5 );
// returns ~0.4769
y = erfcinv( 0.8 );
// returns ~0.1791
y = erfcinv( 0.0 );
// returns Infinity
y = erfcinv( 2.0 );
// returns -Infinity
`
The domain of x is restricted to [0,2]. If x is outside this interval, the function returns NaN.
`javascript`
var y = erfcinv( -3.14 );
// returns NaN
If provided NaN, the function returns NaN.
`javascript`
var y = erfcinv( NaN );
// returns NaN
Examples
`javascript
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var erfcinv = require( '@stdlib/math-base-special-erfcinv' );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, 0.0, 2.0, opts );
logEachMap( 'x: %0.4f, erfcinv(x): %0.4f', x, erfcinv );
`
*
C APIs
$3
`c`
#include "stdlib/math/base/special/erfcinv.h"
#### stdlib_base_erfcinv( x )
Evaluates the [inverse complementary error function][erfcinv].
`c
double out = stdlib_base_erfcinv( 0.5 );
// returns ~0.4769
out = stdlib_base_erfcinv( 0.8 );
// returns ~0.1791
`
The function accepts the following arguments:
- x: [in] double input value.
`c`
double stdlib_base_erfcinv( const double x );
$3
`c
#include "stdlib/math/base/special/erfcinv.h"
#include
int main( void ) {
const double x[] = { 0.0, 0.22, 0.44, 0.67, 0.89, 1.11, 1.33, 1.56, 1.78, 2.0 };
double v;
int i;
for ( i = 0; i < 10; i++ ) {
v = stdlib_base_erfcinv( x[ i ] );
printf( "x: %lf, erfcinv(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/erfinv][@stdlib/math/base/special/erfinv]: inverse error function.
- [@stdlib/math-base/special/erfcx][@stdlib/math/base/special/erfcx]: scaled 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-erfcinv.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-erfcinv
[test-image]: https://github.com/stdlib-js/math-base-special-erfcinv/actions/workflows/test.yml/badge.svg?branch=v0.2.4
[test-url]: https://github.com/stdlib-js/math-base-special-erfcinv/actions/workflows/test.yml?query=branch:v0.2.4
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-erfcinv/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-erfcinv?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-erfcinv/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-erfcinv/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-erfcinv/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-erfcinv/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-erfcinv/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-erfcinv/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-erfcinv/blob/main/branches.md
[erfcinv]: https://en.wikipedia.org/wiki/Error_function#Inverse_functions
[@stdlib/math/base/special/erfinv]: https://www.npmjs.com/package/@stdlib/math-base-special-erfinv
[@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/erfcx]: https://www.npmjs.com/package/@stdlib/math-base-special-erfcx