Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 6/24/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?Log1p

Computes a natural logarithm of vector elements that are increased by 1.

Syntax

vhLog1p( n, a, y );

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

vmhLog1p( n, a, y, mode );

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

vsLog1p( n, a, y );

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

vmsLog1p( n, a, y, mode );

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

vdLog1p( n, a, y );

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

vmdLog1p( n, a, y, mode );

vmdLog1pI(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 _Float16* for vhLog1p, vmhLog1p

const float* for vsLog1p, vmsLog1p

const double* for vdLog1p, vmdLog1p

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.

Output Parameters

Name

Type

Description

y

_Float16* for vhLog1p, vmhLog1p

float* for vsLog1p, vmsLog1p

double* for vdLog1p, vmdLog1p

Pointer to an array that contains the output vector y.

Description

The v?Log1p function computes a natural logarithm of vector elements that are increased by 1.

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