cosh

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 3/22/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-40B1BC25-58E9-4D6F-B3CD-024DE003E691

View Details

cosh

Computes the element-wise hyperbolic cosine of vector elements.

Description
API
Examples

Description

The cosh(a) function computes hyperbolic cosine of vector elements.

Data Type	Threshold Limitations on Input Parameters
single precision	`-Log(FLT_MAX)-Log2 <a[i] < Log(FLT_MAX)+Log2`
double precision	`-Log(DBL_MAX)-Log2 <a[i] < Log(DBL_MAX)+Log2`

Argument	Result	Error Code
+0	+1
-0	+1
X > overflow		`status::overflow`
X < -overflow		`status::overflow`


QNAN	QNAN
SNAN	QNAN



+i·Y	·Cos(Y)- i··Sin(Y)


	·Cos(Y)- i··Sin(Y)

NOTE:

The complex cosh(a) function sets the VM Error Status to 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).

API

Syntax

Buffer API

namespace oneapi::mkl::vm {

sycl::event cosh(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 cosh(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 cosh(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 cosh(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 = {});

}

cosh 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 for a. See Data Types for a description of the oneMKL slice type.
sy: Slice selector for y. 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 is 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 to the input vector.
sa: Slice selector for a. See Data Types for a description of the oneMKL slice type.
sy: Slice selector for y. 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 is 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 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 cosh can be found in the oneMKL installation directory, under:

share/doc/mkl/examples/sycl/vml/source/vcosh.cpp

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

cosh

Description

API

Examples