erfcinv

Computes the inverse complementary error function value of vector elements.

Syntax

Buffer API:

void erfcinv(queue& exec_queue, int64_t n, buffer<T,1>& a, buffer<T,1>& y, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} );

USM API:

event erfcinv(queue& exec_queue, int64_t n, T* a, T* y, vector_class<event>* depends, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} );

erfcinv supports the following precisions and devices:

T Devices supported
float Host, CPU, and GPU
double Host, CPU, and GPU

Description

The erfcinv(a) function computes the inverse complimentary error function values for elements of the input vector a and writes them to the output vector y.

The inverse complementary error function is defined as given by:


Equation


Equation


Equation

where erf(x) denotes the error function and erfinv(x) denotes the inverse error function.

The following figure illustrates the relationships among erfinv family functions (erfinv, erfcinv, cdfnorminv).

erfcinv Family Functions Relationship


Sparse Matrices That Can be Solved With PARDISO

Useful relations for these functions:

Equation


Sparse Matrices That Can be Solved With PARDISO

Special Values for Real Function erfcinv(a)
Argument Result Error Code
+1 +0  
+2 - status::sing
-0 + status::sing
+0 + status::sing
a < -0 QNAN status::errdom
a > +2 QNAN status::errdom
+ QNAN status::errdom
- QNAN status::errdom
QNAN QNAN  
SNAN QNAN  

Input Parameters

Buffer API:

exec_queue

The queue where the routine should be executed.

n

Specifies the number of elements to be calculated.

a

The buffer a containing input vector of size n.

mode

Overrides the global VM mode setting for this function call. See set_mode function for possible values and their description. This is an optional parameter. The default value is mode::not_defined.

errhandler

Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.

USM API:

exec_queue

The queue where the routine should be executed.

n

Specifies the number of elements to be calculated.

a

Pointer a to the input vector of size n.

depends

Vector of dependent events (to wait for input data to be ready).

mode

Overrides the global VM mode setting for this function call. See the set_mode function for possible values and their description. This is an optional parameter. The default value is mode::not_defined.

errhandler

Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.

Output Parameters

Buffer API:

y

The buffer y containing the output vector of size n.

USM API:

y

Pointer y to the output vector of size n.

return value (event)

Function end event.

Example

An example of how to use erfcinvcan be found in the Intel® oneMKL installation directory, under:

examples/sycl/vml/verfcinv.cpp