sin
sin#
Computes sine of vector elements.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
sycl::event sin(
sycl::queue& exec_queue,
std::int64_t n,
sycl::buffer<T,1>& a,
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:
namespace oneapi::mkl::vm {
sycl::event sin(
sycl::queue& exec_queue,
std::int64_t n,
const T *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
sin
supports the following precisions.
T |
---|
|
|
|
|
Description
The sin(a)function computes sine of vector elements.
Note that arguments abs(a[i]) ≤ 213
and abs(a[i]) ≤ 216
for
single and double precisions respectively are called fast
computational path. These are trigonometric function arguments for
which VM provides the best possible performance. Avoid arguments that
do not belong to the fast computational path in the VM High Accuracy
(HA) and Low Accuracy (LA) functions. Alternatively, you can use VM
Enhanced Performance (EP) functions that are fast on the entire
function domain. However, these functions provide less accuracy.
Argument |
Result |
VM status code |
---|---|---|
+0 |
+0 |
|
-0 |
-0 |
|
+∞ |
QNAN |
|
-∞ |
QNAN |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
Specifications for special values of the complex functions are defined according to the following formula
Sin(z) = -i*Sinh(i*z)
.
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
.- 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
oneapi::mkl::vm::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
.- 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
oneapi::mkl::vm::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)
Event, signifying availability of computed output and status code(s).
Exceptions
For list of generated exceptions please refer to Exceptions
Parent topic: VM Mathematical Functions