Visible to Intel only — GUID: GUID-E887B9B0-85FD-405B-A4D6-06775FF68B6F
Visible to Intel only — GUID: GUID-E887B9B0-85FD-405B-A4D6-06775FF68B6F
exp
Computes the element-wise natural (base-e) exponential of vector elements.
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 |
- 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.
API
Syntax
Buffer API
namespace oneapi::mkl::vm { sycl::event exp(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 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 mode = oneapi::mkl::vm::mode::not_defined, oneapi::mkl::vm::error_handler<T> errhandler = {}); }
USM API
namespace oneapi::mkl::vm { sycl::event exp(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 exp(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 = {}); }
exp 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 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 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 exp can be found in the oneMKL installation directory, under:
examples/dpcpp/vml/source/vexp.cpp