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?Expm1

Computes an exponential of vector elements decreased by 1.

Syntax

vsExpm1( n, a, y );

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

vmsExpm1( n, a, y, mode );

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

vdExpm1( n, a, y );

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

vmdExpm1( n, a, y, mode );

vmdExpm1I(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 vsExpm1, vmsExpm1

const double* for vdExpm1, vmdExpm1

Pointer to an array that contains the input vector a.

inca, incy

const 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.

Precision Overflow Thresholds for Expm1 Function
Data Type Threshold Limitations on Input Parameters
single precision a[i] < Ln( FLT_MAX )
double precision a[i] < Ln( DBL_MAX )

Output Parameters

Name

Type

Description

y

float* for vsExpm1, vmsExpm1

double* for vdExpm1, vmdExpm1

Pointer to an array that contains the output vector y.

Description

The v?Expm1 function computes an exponential of vector elements decreased by 1.

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