erf

Computes the error function value of vector elements.

Syntax

Buffer API:

void erf(queue &exec_queue, int64_t n, buffer<T, 1> &a, buffer<T, 1> &y, uint64_t mode = mode::not_defined)

USM API:

event erf(queue &exec_queue, int64_t n, T *a, T *y, vector_class<event> *depends, uint64_t mode = mode::not_defined)

erf supports the following precisions.

T
float
double

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:

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 erf family functions (erf, erfc, cdfnorm).

erf Family Functions Relationship |

Useful relations for these functions:

Argument	Result	Error Code
+∞	+1
-∞	-1
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.

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.

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 erf can be found in the oneMKL installation directory, under:

examples/sycl/vml/verf.cpp

Parent topic: Special Functions