sinpi
sinpi#
Computes the sine of vector elements multiplied by π
.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
sycl::event sinpi(
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 sinpi(
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
sinpi
supports the following precisions.
T |
---|
|
|
Description
The sinpi(a) function computes the sine of vector elements multiplied
by π
. For an argument a
, the function computes
sin(π
*a
).
Argument |
Result |
Status code |
---|---|---|
+0 |
+0 |
|
-0 |
-0 |
|
+ |
+0 |
|
- |
-0 |
|
+∞ |
QNAN |
|
-∞ |
QNAN |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
If arguments abs(a
i) ≤ 222 for single precision
or abs(a
i ) ≤ 251 for double precision, they
belong to the fast computational path: arguments for which VM
provides the best possible performance. Avoid arguments which do not
belong to the fast computational path in VM High Accuracy (HA) or Low
Accuracy (LA) functions. For arguments which do not belong to the
fast computational path you can use VM Enhanced Performance (EP)
functions, which are fast on the entire function domain. However,
these functions provide lower accuracy.
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