Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

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

Document Table of Contents

v?Acosh

Computes inverse hyperbolic cosine (nonnegative) of vector elements.

Syntax

vsAcosh( n, a, y );

vsAcoshI(n, a, inca, y, incy);

vmsAcosh( n, a, y, mode );

vmsAcoshI(n, a, inca, y, incy, mode);

vdAcosh( n, a, y );

vdAcoshI(n, a, inca, y, incy);

vmdAcosh( n, a, y, mode );

vmdAcoshI(n, a, inca, y, incy, mode);

vcAcosh( n, a, y );

vcAcoshI(n, a, inca, y, incy);

vmcAcosh( n, a, y, mode );

vmcAcoshI(n, a, inca, y, incy, mode);

vzAcosh( n, a, y );

vzAcoshI(n, a, inca, y, incy);

vmzAcosh( n, a, y, mode );

vmzAcoshI(n, a, inca, y, incy, mode);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

n

const MKL_INT

Specifies the number of elements to be calculated.

a

const float* for vsAcosh, vmsAcosh

const double* for vdAcosh, vmdAcosh

const MKL_Complex8* for vcAcosh, vmcAcosh

const MKL_Complex16* for vzAcosh, vmzAcosh

Pointer to an array that contains the input vector a.

inca, incy

cnst MKL_INT

Specifies increments for the elements of a and y.

mode

const MKL_INT64

Overrides global VM mode setting for this function call. See vmlSetMode for possible values and their description.

Output Parameters

Name

Type

Description

y

float* for vsAcosh, vmsAcosh

double* for vdAcosh, vmdAcosh

MKL_Complex8* for vcAcosh, vmcAcosh

MKL_Complex16* for vzAcosh, vmzAcosh

Pointer to an array that contains the output vector y.

Description

The v?Acosh function computes inverse hyperbolic cosine (nonnegative) of vector elements.

Special Values for Real Function v?Acosh(x)
Argument Result VM Error Status Exception
+1 +0    
X < +1 QNAN VML_STATUS_ERRDOM INVALID
- QNAN VML_STATUS_ERRDOM INVALID
+ +    
QNAN QNAN    
SNAN QNAN   INVALID

See Special Value Notations for the conventions used in the table below.

Special Values for Complex Function v?Acosh(z)

RE(z)

i·IM(z)

-

 

-X

 

-0

 

+0

 

+X

 

+

 

NAN

 

+i· ++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· +-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:

  • raises INVALID exception when real or imaginary part of the argument is SNAN

  • Acosh(CONJ(z))=CONJ(Acosh(z)).