Performs element by element subtraction of vector b
from vector
a
.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
sycl::event sub(
sycl::queue& exec_queue,
std::int64_t n,
sycl::buffer<T,1>& a,
sycl::buffer<T,1>& b,
sycl::buffer<T,1>& y,
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});
} // namespace oneapi::mkl::vm
USM API:
.. code-block:: cpp
namespace oneapi::mkl::vm {
- sycl::event sub(
- sycl::queue& exec_queue, std::int64_t n, const T a, const T *b, 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
sub
supports the following precisions.
T |
---|
float |
double |
std::complex<float> |
std::complex<double> |
Description
The sub(a, b) function performs element by element subtraction of
vector a
and vector b
.
Argument 1 | Argument 2 | Result | Status code |
---|---|---|---|
+0 | +0 | +0 | |
+0 | -0 | +0 | |
-0 | +0 | +0 | |
-0 | -0 | -0 | |
+∞ | +∞ | QNAN | |
+∞ | -∞ | +∞ | |
-∞ | +∞ | -∞ | |
-∞ | -∞ | QNAN | |
SNAN | any value | QNAN | |
any value | SNAN | QNAN |
Specifications for special values of the complex functions are defined according to the following formula
sub(x1+i*y1, x2+i*y2) = (x1-x2) + i*(y1-y2)
Overflow in a complex function occurs (supported in the HA/LA
accuracy modes only) when all RE(x), RE(y), IM(x), IM(y) arguments
are finite numbers, but the real or imaginary part of the computed
result is so large that it does not fit the target precision. In this
case, the function returns ∞ in that part of the result, and sets the
VM status code to oneapi::mkl::vm::status::overflow
(overriding any possible
oneapi::mkl::vm::status::accuracy_warning
status).
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
. - b
- The buffer
b
containing 2nd input vector of sizen
. - mode
- Overrides the global VM mode setting for this function call. See
:ref:`onemkl_vm_setmode`
function for possible values and their description. This is an
optional parameter. The default value is
oneapi::mkl::vm::mode::not_defined
. - errhandler
- Sets local error handling mode for this function call. See the :ref:`onemkl_vm_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
. - b
- Pointer
b
to the 2nd input vector of sizen
. - 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 :ref:`onemkl_vm_setmode`
function for possible values and their description. This is an
optional parameter. The default value is
oneapi::mkl::vm::mode::not_defined
. - errhandler
- Sets local error handling mode for this function call. See the :ref:`onemkl_vm_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)
- Event, signifying availability of computed output and status code(s).
Exceptions
For list of generated exceptions please refer to :ref:`onemkl_vm_exceptions`