div¶
Performs element by element division of vector a
by vector b
Syntax
Buffer API:
namespace oneapi::mkl::vm {
void div(queue& exec_queue,
int64_t n, buffer<T,1>& a,
buffer<T,1>& b,
buffer<T,1>& y,
uint64_t mode = mode::not_defined,
error_handler<T> errhandler = {} )
}
namespace oneapi::mkl::vm {
sycl::event div(
sycl::queue & exec_queue,
sycl::buffer<T> & a, oneapi::mkl::slice sa, sycl::buffer<T> & b, oneapi::mkl::slice sb, 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 div(queue& exec_queue,
int64_t n,
T* a,
T* b,
T* y,
vector_class<event> const & depends = {},
uint64_t mode = mode::not_defined,
error_handler<T> errhandler = {} )
}
namespace oneapi::mkl::vm {
sycl::event div(sycl::queue & exec_queue,
T const * a,
oneapi::mkl::slice sa,
T const * b,
oneapi::mkl::slice sb,
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 = {});
}
div
supports the following precisions and devices:
T |
Devices supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
Description
The div(a,b) function performs element by element division of vector
a
by vector b
.
Argument 1 |
Argument 2 |
Result |
VM Error Status |
---|---|---|---|
X > +0 |
+0 |
+∞ |
|
X > +0 |
-0 |
-∞ |
|
X < +0 |
+0 |
-∞ |
|
X < +0 |
-0 |
+∞ |
|
+0 |
+0 |
QNAN |
|
-0 |
-0 |
QNAN |
|
X > +0 |
+∞ |
+0 |
|
X > +0 |
-∞ |
-0 |
|
+∞ |
+∞ |
QNAN |
|
-∞ |
-∞ |
QNAN |
|
QNAN |
QNAN |
QNAN |
|
SNAN |
SNAN |
QNAN |
Specifications for special values of the complex functions are defined according to the following formula
Div(x1+i*y1,x2+i*y2) = (x1+i*y1)*(x2-i*y2)/(x2*x2+y2*y2)
.
Overflow in a complex function occurs when x2+i*y2
is not zero,
x1, x2, y1, y2 are finite numbers, but the real or imaginary part of
the exact result is so large that it does not fit the target
precision. In that case, the function returns ∞ in that part of the
result, and sets the VM Error Status to status::overflow.
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 1st input vector of sizen
.- sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.- b
The buffer
b
containing 2nd input vector of sizen
.- sb
Slice selector for
b
. 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 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 1st input vector of sizen
.- sa
Slice selector for
a
. See Data Types for a description of the oneMKL slice type.- b
Pointer
b
to the 2nd input vector of sizen
.- sb
Slice selector for
b
. 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 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
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 divcan be found in the Intel® oneMKL installation directory, under:
examples/dpcpp/vml/source/vdiv.cpp