v?Sinh

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

Download PDF

ID 766686

Date 11/07/2023

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-890A8578-A692-4A3B-AE60-07117E9496B6

View Details

v?Sinh

Computes hyperbolic sine of vector elements.

Syntax

call vssinh( n, a, y )

call vssinhi(n, a, inca, y, incy)

call vmssinh( n, a, y, mode )

call vmssinhi(n, a, inca, y, incy, mode)

call vdsinh( n, a, y )

call vdsinhi(n, a, inca, y, incy)

call vmdsinh( n, a, y, mode )

call vmdsinhi(n, a, inca, y, incy, mode)

call vcsinh( n, a, y )

call vcsinhi(n, a, inca, y, incy)

call vmcsinh( n, a, y, mode )

call vmcsinhi(n, a, inca, y, incy, mode)

call vzsinh( n, a, y )

call vzsinhi(n, a, inca, y, incy)

call vmzsinh( n, a, y, mode )

call vmzsinhi(n, a, inca, y, incy, mode)

Include Files

mkl_vml.f90

Input Parameters

Name	Type	Description
n	INTEGER, INTENT(IN)	Specifies the number of elements to be calculated.
a	DOUBLE PRECISION for vdsinh, vmdsinh COMPLEX for vcsinh, vmcsinh DOUBLE COMPLEX for vzsinh, vmzsinh REAL, INTENT(IN) for vssinh, vmssinh DOUBLE PRECISION, INTENT(IN) for vdsinh, vmdsinh COMPLEX, INTENT(IN) for vcsinh, vmcsinh DOUBLE COMPLEX, INTENT(IN) for vzsinh, vmzsinh	Array that specifies the input vector a.
inca, incy	INTEGER, INTENT(IN)	Specifies increments for the elements of `a` and `y`.
mode	INTEGER(KIND=8), INTENT(IN)	Overrides global VM mode setting for this function call. See vmlSetMode for possible values and their description.

Precision Overflow Thresholds for Real v?Sinh Function
Data Type	Threshold Limitations on Input Parameters
single precision	`-Ln(FLT_MAX)-Ln2 <a[i] < Ln(FLT_MAX)+Ln2`
double precision	`-Ln(DBL_MAX)-Ln2 <a[i] < Ln(DBL_MAX)+Ln2`

Precision overflow thresholds for the complex v?Sinh function are beyond the scope of this document.

Output Parameters

Name	Type	Description
y	DOUBLE PRECISION for vdsinh, vmdsinh COMPLEX for vcsinh, vmcsinh DOUBLE COMPLEX for vzsinh, vmzsinh REAL, INTENT(OUT) for vssinh, vmssinh DOUBLE PRECISION, INTENT(OUT) for vdsinh, vmdsinh COMPLEX, INTENT(OUT) for vcsinh, vmcsinh DOUBLE COMPLEX, INTENT(OUT) for vzsinh, vmzsinh	Array that specifies the output vector y.

Name

Type

Description

DOUBLE PRECISION for vdsinh, vmdsinh

COMPLEX for vcsinh, vmcsinh

DOUBLE COMPLEX for vzsinh, vmzsinh

REAL, INTENT(OUT) for vssinh, vmssinh

DOUBLE PRECISION, INTENT(OUT) for vdsinh, vmdsinh

COMPLEX, INTENT(OUT) for vcsinh, vmcsinh

DOUBLE COMPLEX, INTENT(OUT) for vzsinh, vmzsinh

Array that specifies the output vector y.

Description

The v?Sinh function computes hyperbolic sine of vector elements.

Special Values for Real Function v?Sinh(x)
Argument	Result	VM Error Status	Exception
+0	+0
-0	-0
X > overflow	+∞	VML_STATUS_OVERFLOW	OVERFLOW
X < -overflow	-∞	VML_STATUS_OVERFLOW	OVERFLOW
+∞	+∞
-∞	-∞
QNAN	QNAN
SNAN	QNAN		INVALID

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

Special Values for Complex Function v?Sinh(z)
RE(z) i·IM(z)	-∞	-X	-0	+0	+X	+∞	NAN
+i·∞	-∞+i·QNAN INVALID	QNAN+i·QNAN INVALID	-0+i·QNAN INVALID	+0+i·QNAN INVALID	QNAN+i·QNAN INVALID	+∞+i·QNAN INVALID	QNAN+i·QNAN
+i·Y	-∞·Cos(Y)+ i·∞·Sin(Y)					+∞·CIS(Y)	QNAN+i·QNAN
+i·0	-∞+i·0		-0+i·0	+0+i·0		+∞+i·0	QNAN+i·0
-i·0	-∞-i·0		-0-i·0	+0-i·0		+∞-i·0	QNAN-i·0
-i·Y	-∞·Cos(Y)+ i·∞·Sin(Y)					+∞·CIS(Y)	QNAN+i·QNAN
-i·∞	-∞+i·QNAN INVALID	QNAN+i·QNAN INVALID	-0+i·QNAN INVALID	+0+i·QNAN INVALID	QNAN+i·QNAN INVALID	+∞+i·QNAN INVALID	QNAN+i·QNAN
+i·NAN	-∞+i·QNAN	QNAN+i·QNAN	-0+i·QNAN	+0+i·QNAN	QNAN+i·QNAN	+∞+i·QNAN	QNAN+i·QNAN

Notes:

raises the INVALID exception when the real or imaginary part of the argument is SNAN
raises the OVERFLOW exception and sets the VM Error Status to VML_STATUS_OVERFLOW in the case of overflow, that is, when RE(z), IM(z) 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.
Sinh(CONJ(z))=CONJ(Sinh(z))
Sinh(-z)=-Sinh(z).

Parent topic: Hyperbolic Functions

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

v?Sinh

Syntax

Include Files

Input Parameters

Output Parameters

Description