acosh

acosh#

Computes inverse hyperbolic cosine (nonnegative) of vector elements.

Syntax

Buffer API:

namespace oneapi::mkl::vm {

sycl::event acosh(
        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 acosh(
        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

acosh supports the following precisions.

T
`float`
`double`
`std::complex<float>`
`std::complex<double>`

Description

The acosh(a) function computes inverse hyperbolic cosine (nonnegative) of vector elements.

Argument	Result	Status code
+1	+0
a < +1	QNAN	`oneapi::mkl::vm::status::errdom`
-∞	QNAN	`oneapi::mkl::vm::status::errdom`
+∞	+∞
QNAN	QNAN
SNAN	QNAN

RE(a) i·IM(a)	-∞	-X	-0	+0	+X	+∞	NAN
+i·∞	\(+\infty + i \cdot \frac{3\pi}{4}\)	+∞+i·`π`/2	+∞+i·`π`/2	+∞+i·`π`/2	+∞+i·`π`/2	+∞+i·`π`/4	+∞+i·QNAN
+i·Y	+∞+i·`π`					+∞+i·0	QNAN+i·QNAN
+i·0	+∞+i·`π`		+0+i·`π`/2	+0+i·`π`/2		+∞+i·0	QNAN+i·QNAN
-i·0	+∞+i·`π`		+0+i·`π`/2	+0+i·`π`/2		+∞+i·0	QNAN+i·QNAN
-i·Y	+∞+i·`π`					+∞+i·0	QNAN+i·QNAN
-i·∞	\(+\infty - i \cdot \frac{3\pi}{4}\)	+∞-i·`π`/2	+∞-i·`π`/2	+∞-i·`π`/2	+∞-i·`π`/2	+∞-i·`π`/4	+∞+i·QNAN
+i·NAN	+∞+i·QNAN	QNAN+i·QNAN	QNAN+i·QNAN	QNAN+i·QNAN	QNAN+i·QNAN	+∞+i·QNAN	QNAN+i·QNAN

Notes:

acosh(CONJ(a))=CONJ(acosh(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 size n.
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 size n.
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 size n.

USM API:

y: Pointer y to the output vector of size n.
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