cosh¶
Computes hyperbolic cosine of vector elements.
Syntax
Buffer API:
namespace oneapi::mkl::vm {
sycl::event cosh(
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 cosh(
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
cosh
supports the following precisions.
T |
---|
|
|
|
|
Description
The cosh(a) function computes hyperbolic cosine of vector elements.
Data Type |
Threshold Limitations on Input Parameters |
---|---|
single precision |
|
double precision |
|
Argument |
Result |
Status code |
---|---|---|
+0 |
+1 |
|
-0 |
+1 |
|
X > overflow |
+∞ |
|
X < -overflow |
+∞ |
|
+∞ |
+∞ |
|
-∞ |
+∞ |
|
QNAN |
QNAN |
|
SNAN |
QNAN |
+i·∞ |
+∞+i·QNAN |
QNAN+i·QNAN |
QNAN-i·0 |
QNAN+i·0 |
QNAN+i·QNAN |
+∞+i·QNAN |
QNAN+i·QNAN |
+i·Y |
+∞·Cos(Y)- i·∞·Sin(Y) |
+∞·CIS(Y) |
QNAN+i·QNAN |
||||
+i·0 |
+∞-i·0 |
+1-i·0 |
+1+i·0 |
+∞+i·0 |
QNAN+i·0 |
||
-i·0 |
+∞+i·0 |
+1+i·0 |
+1-i·0 |
+∞-i·0 |
QNAN-i·0 |
||
-i·Y |
+∞·Cos(Y)- i·∞·Sin(Y) |
+∞·CIS(Y) |
QNAN+i·QNAN |
||||
-i·∞ |
+∞+i·QNAN |
QNAN+i·QNAN |
QNAN+i·0 |
QNAN-i·0 |
QNAN+i·QNAN |
+∞+i·QNAN |
QNAN+i·QNAN |
+i·NAN |
+∞+i·QNAN |
QNAN+i·QNAN |
QNAN+i·QNAN |
QNAN-i·QNAN |
QNAN+i·QNAN |
+∞+i·QNAN |
QNAN+i·QNAN |
Notes:
- The complex cosh(a) function sets the VM status code to
oneapi::mkl::vm::status::overflow
in 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.
cosh(CONJ(a))=CONJ(cosh(a))
cosh(-a)=cosh(a)
.
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