Computes inverse error function value of vector elements.
Buffer API:
void erfinv(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 erfinv(queue& exec_queue, int64_t n, T* a, T* y, vector_class<event>* depends, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} );
erfinv supports the following precisions and devices:
T | Devices supported |
---|---|
float | Host, CPU, and GPU |
double | Host, CPU, and GPU |
The erfinv(a) function computes the inverse error function values for elements of the input vector a and writes them to the output vector y
y = erf-1(a),
where erf(x) is the error function defined as given by:
Useful relations:
where erfc is the complementary error function.
where
is the cumulative normal distribution function.
where Φ-1(x) and erf-1(x) are the inverses to Φ(x) and erf(x), respectively.
The following figure illustrates the relationships among erfinv family functions (erfinv, erfcinv, cdfnorminv).
Useful relations for these functions:
Argument | Result | Error Code |
---|---|---|
+0 | +0 | |
-0 | -0 | |
+1 | +∞ | status::sing |
-1 | -∞ | status::sing |
|a| > 1 | QNAN | status::errdom |
+∞ | QNAN | status::errdom |
-∞ | QNAN | status::errdom |
QNAN | QNAN | |
SNAN | QNAN |
Buffer API:
The queue where the routine should be executed.
Specifies the number of elements to be calculated.
The buffer a containing input vector of size n.
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.
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:
The queue where the routine should be executed.
Specifies the number of elements to be calculated.
Pointer a to the input vector of size n.
Vector of dependent events (to wait for input data to be ready).
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.
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.
Buffer API:
The buffer y containing the output vector of size n.
USM API:
Pointer y to the output vector of size n.
Function end event.
An example of how to use erfinvcan be found in the Intel® oneMKL installation directory, under:
examples/sycl/vml/verfinv.cpp