acosh¶

Computes the element-wise inverse hyperbolic cosine of vector elements.

Description ¶

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

Argument	Result	Error Code
+1	+0
a < +1	QNAN	`status::errdom`
$- \infty$	QNAN	`status::errdom`
$+ \infty$	$+ \infty$
QNAN	QNAN
SNAN	QNAN

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

Note

acosh(CONJ(a))=CONJ(acosh(a)).

API ¶

Syntax¶

Buffer API

namespace oneapi::mkl::vm {

sycl::event acosh(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 acosh(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 acosh(sycl::queue & exec_queue,
      std::int64_t n,
      T const * a,
      T * y,
      std::vector<cl::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 acosh(sycl::queue & exec_queue,
      T const * a,
      oneapi::mkl::slice sa,
      T * y,
      oneapi::mkl::slice sy,
      std::vector<cl::sycl::event> const & depends = {},
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
      oneapi::mkl::vm::error_handler<T> errhandler = {});

}

acosh supports the following precisions and devices:

T	Devices supported
`float`	Host, CPU, and GPU
`double`	Host, CPU, and GPU
`std::complex<float>`	Host
`std::complex<double>`	Host

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 acosh can be found in the oneMKL installation directory, under:

examples/dpcpp/vml/source/vacosh.cpp

tanh asinh

oneAPI Math Kernel Library (oneMKL) documentation

acosh¶

Description¶

API¶

Syntax¶

Input Parameters¶

Output Parameters¶

Examples¶

Description ¶

API ¶

Examples ¶