Visible to Intel only — GUID: GUID-DD2BA80D-A887-41DE-8F84-B75A53DBE9D2
Visible to Intel only — GUID: GUID-DD2BA80D-A887-41DE-8F84-B75A53DBE9D2
erf
Computes the element-wise error function of vector elements.
Description
The erf function computes the error function values for elements of the input vector a and writes them to the output vector y.
The error function is 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/1776880F-33C2-433A-B3F9-A7BADFA4C60A-low.png)
where erfc is the complementary error function.
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/87595B72-6358-4CF8-A346-103F02C19562-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/329CF076-2A53-4342-B647-7C9BBFBA12BE-low.png)
where and erf-1(x) are the inverses to
and erf(x), respectively.
The following figure illustrates the relationships among erf family functions (erf, erfc, cdfnorm).
![erf Family Functions Relationship](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/AA203C0F-E1D5-493A-AF6C-6F26F94637D1-low.png)
Useful relations for these functions:
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/A40C9A1B-8829-427E-808D-8605A781A253-low.png)
![](/content/dam/docs/us/en/developer-reference-dpcpp/2024-1/3EA3467D-EEC8-45FA-BC1A-4A8E9E09FD47-low.png)
Argument |
Result |
Error Code |
---|---|---|
+ |
+1 |
|
- |
-1 |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
API
Syntax
Buffer API
namespace oneapi::mkl::vm {
sycl::event erf(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);
}
namespace oneapi::mkl::vm {
sycl::event erf(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);
}
USM API
namespace oneapi::mkl::vm {
sycl::event erf(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);
}
namespace oneapi::mkl::vm {
sycl::event erf(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);
}
erf 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.
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 set_mode function for possible values and their description. This is an optional parameter. The default value is mode::not_defined.
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 erf can be found in the oneMKL installation directory, under:
share/doc/mkl/examples/sycl/vml/source/verf.cpp