erfinv

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-4663527C-B069-4261-80F4-50DADAFC0159

View Details

erfinv

Computes the element-wise inverse error function of vector elements.

Description
API
Examples

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:

Useful relations:

where erfc is the complementary error function.

where

is the cumulative normal distribution function.

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

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

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
`sycl::half`	GPU
`_Float16`	CPU
`float`	CPU and GPU
`double`	CPU and GPU

Input Parameters

Buffer API

exec_queue: The queue where the routine will 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 will 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

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

erfinv

Description

API

Examples