Visible to Intel only — GUID: GUID-3192FC54-E8E2-49E6-90F4-3BEFF86CAF29
Visible to Intel only — GUID: GUID-3192FC54-E8E2-49E6-90F4-3BEFF86CAF29
erfinv
Computes the element-wise inverse error function of vector elements.
Description
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:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/95339C99-EE74-473B-BBF0-90A8EB61BD15-low.png)
Useful relations:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/CCF2FAF3-BCCA-4ACA-AC97-5EB168CA2D77-low.png)
where erfc is the complementary error function.
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/47C9CB47-4F86-4A55-86B5-ED3CD27A2492-low.png)
where
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/115DE16C-9120-48A6-852F-C8AD8DA7B5C1-low.png)
is the cumulative normal distribution function.
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/80DC94C0-E32C-4EBE-B303-45B6816B7093-low.png)
where and erf-1(x) are the inverses to
and erf(x), respectively.
The following figure illustrates the relationships among erfinv family functions (erfinv, erfcinv, cdfnorminv).
![erfinv Family Functions Relationship](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/D79A00F3-E1E3-4F3B-985F-7BE244A963E6-low.png)
Useful relations for these functions:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/84FEA303-EE5C-4B0F-81B3-D64EDD974C2C-low.png)
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/810D4DD7-7BCD-459A-B150-B33C4E06693E-low.png)
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 |
API
Syntax
Buffer API
namespace oneapi::mkl::vm {
sycl::event erfinv(sycl::queue & exec_queue,
std::int64_t n,
sycl::buffer<T> & a,
sycl::buffer<T> & y,
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
namespace oneapi::mkl::vm {
sycl::event erfinv(sycl::queue & exec_queue,
sycl::buffer<T> & a,
oneapi::mkl::slice sa,
sycl::buffer<T> & y,
oneapi::mkl::slice sy,
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
USM API
namespace oneapi::mkl::vm {
sycl::event erfinv(sycl::queue & exec_queue,
std::int64_t n,
T const * a,
T * y,
std::vector<sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
namespace oneapi::mkl::vm {
sycl::event erfinv(sycl::queue & exec_queue,
T const * a,
oneapi::mkl::slice sa,
T * y,
oneapi::mkl::slice sy,
std::vector<sycl::event> const & depends = {},
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
}
erfinv supports the following precisions and devices:
T |
Devices supported |
---|---|
float |
CPU and GPU |
double |
CPU and GPU |
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 containing the input vector.
- sa
-
Slice selector for a. See Data Types for a description of the oneMKL slice type.
- sy
-
Slice selector for y. See Data Types for a description of the oneMKL slice type.
- 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.
USM API
- exec_queue
-
The queue where the routine should be executed.
- n
-
Specifies the number of elements to be calculated.
- a
-
Pointer to the input vector.
- sa
-
Slice selector for a. See Data Types for a description of the oneMKL slice type.
- sy
-
Slice selector for y. See Data Types for a description of the oneMKL slice type.
- depends
-
Vector of dependent events (to wait for input data to be ready). This is an optional parameter. The default is an empty vector.
- mode
-
Overrides the global VM mode setting for this function call. See the 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 containing the output vector.
- return value (event)
-
Computation end event.
USM API
- y
-
Pointer to the output vector.
- return value (event)
-
Computation end event.
Examples
An example of how to use erfinv can be found in the oneMKL installation directory, under:
share/doc/mkl/examples/sycl/vml/source/verfinv.cpp