sinh
Computes the element-wise hyperbolic sine of vector elements.
Description
The
sinh(a)
function computes hyperbolic sine of vector elements.Data Type | Threshold Limitations on Input Parameters |
---|---|
single precision | -Log(FLT_MAX)-Log(2) <a[i] < Log(FLT_MAX)+Log(2) |
double precision | -Log(DBL_MAX)-Log(2) <a[i] < Log(DBL_MAX)+Log(2) |
Argument | Result | Error Code |
---|---|---|
+0 | +0 | |
-0 | -0 | |
a > overflow | + ![]() | status::overflow |
a < -overflow | - ![]() | status::overflow |
+ ![]() | + ![]() | |
- ![]() | - ![]() | |
QNAN | QNAN | |
SNAN | QNAN |
![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ![]() |
![]() | ![]() ![]() | ![]() | ![]() | ||||
![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ||
![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ||
![]() | ![]() | ![]() | ![]() | ||||
![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ![]() |
![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ![]() | ![]() |
- The complexsinh(a)function sets the VM Error Status tostatus::overflowin the case of overflow, that is, when RE(a), IM(a) 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.
- sinh(CONJ(a))=CONJ(sinh(a))
- sinh(-a)=-sinh(a).
API
Syntax
Buffer API
namespace oneapi::mkl::vm {
sycl::event sinh(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 sinh(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 sinh(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 sinh(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 = {});
}
sinh
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 fora. See Data Types for a description of the oneMKL slice type.
- sy
- Slice selector fory. 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 ismode::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 fora. See Data Types for a description of the oneMKL slice type.
- sy
- Slice selector fory. 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 ismode::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 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
sinh
can be found in the oneMKL
installation directory, under:examples/dpcpp/vml/source/vsinh.cpp