exp¶
Computes an exponential of vector elements.
Syntax
Buffer API:
namespace oneapi::mkl::vm { void exp(queue& exec_queue, int64_t n, buffer<T,1>& a, buffer<T,1>& y, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} ) }namespace oneapi::mkl::vm { sycl::event exp(sycl::queue & exec_queue, sycl::buffer<T> & a, oneapi::mkl::slice sa, sycl::buffer<T> & y, oneapi::mkl::slice sy, oneapi::mkl::vm::mode lib_mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler<T> eh = {}); }USM API:
namespace oneapi::mkl::vm { event exp(queue& exec_queue, int64_t n, T* a, T* y, vector_class<event> const & depends = {}, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {} ) }namespace oneapi::mkl::vm { sycl::event exp(sycl::queue & exec_queue, T const * a, oneapi::mkl::slice sa, T * y, oneapi::mkl::slice sy, sycl::vector_class<cl::sycl::event> const & depends = {}, oneapi::mkl::vm::mode lib_mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler<T> eh = {}); }
exp
supports the following precisions and devices:
T
Devices supported
float
Host, CPU, and GPU
double
Host, CPU, and GPU
std::complex<float>
Host
std::complex<double>
Host
Description
The exp(a) function computes an exponential of vector elements.
Data Type
Threshold Limitations on Input Parameters
single precision
a[i] < Log( FLT_MAX )
double precision
a[i] < Log( DBL_MAX )
Argument
Result
Error Code
+0
+1
-0
+1
a > overflow
+∞
status::overflow
a < underflow
+0
status::overflow
+∞
+∞
-∞
+0
QNAN
QNAN
SNAN
QNAN
+i·∞
+i·Y
+i·0
-i·0
-i·Y
-i·∞
+i·NAN
Notes:
The complex exp(z) function sets the VM Error Status to status::overflow in the case of overflow, that is, when both RE(z) and IM(z) are finite non-zero numbers, but the real or imaginary part of the exact result is so large that it does not meet the target precision.
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 sizen
.- 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
a
to the input vector of sizen
.- 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).
- 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 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
y
containing the output vector of sizen
.USM API:
- y
Pointer
y
to the output vector of sizen
.- return value (event)
Function end event.
Example
An example of how to use expcan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vexp.cpp