Developer Reference for Intel® oneAPI Math Kernel Library for C
A newer version of this document is available. Customers should click here to go to the newest version.
v?Ln
vsLn vmsLn vdLn vmdLn vcLn vmcLn vzLn vmzLn Computes natural logarithm of vector elements.
Syntax
vhLn ( n , a , y ) ;
vhLnI(n, a, inca, y, incy);
vmhLn ( n , a , y , mode ) ;
vmhLnI(n, a, inca, y, incy, mode);
vsLn ( n , a , y ) ;
vsLnI(n, a, inca, y, incy);
vmsLn ( n , a , y , mode ) ;
vmsLnI(n, a, inca, y, incy, mode);
vdLn ( n , a , y ) ;
vdLnI(n, a, inca, y, incy);
vmdLn ( n , a , y , mode ) ;
vmdLnI(n, a, inca, y, incy, mode);
vcLn ( n , a , y ) ;
vcLnI(n, a, inca, y, incy);
vmcLn ( n , a , y , mode ) ;
vmcLnI(n, a, inca, y, incy, mode);
vzLn ( n , a , y ) ;
vzLnI(n, a, inca, y, incy);
vmzLn ( n , a , y , mode ) ;
vmzLnI(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 vhLn , vmhLn const float* for vsLn , vmsLn const double* for vdLn , vmdLn const MKL_Complex8* for vcLn , vmcLn const MKL_Complex16* for vzLn , vmzLn |
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 (Sets a new mode for VM functions according to the mode parameter and stores the previous VM mode to oldmode.) for possible values and their description. |
Output Parameters
Name |
Type |
Description |
|---|---|---|
y |
_Float16* for vhLn , vmhLn float* for vsLn , vmsLn double* for vdLn , vmdLn MKL_Complex8* for vcLn , vmcLn MKL_Complex16* for vzLn , vmzLn |
Pointer to an array that contains the output vector y . |
Description
The v?Ln function computes natural logarithm of vector elements.
Special Values for Real Function v?Ln(x)
Argument |
Result |
VM Error Status |
Exception |
|---|---|---|---|
+1 |
+0 |
||
X < +0 |
QNAN |
VML_STATUS_ERRDOM |
INVALID |
+0 |
|
VML_STATUS_SING |
ZERODIVIDE |
-0 |
|
VML_STATUS_SING |
ZERODIVIDE |
|
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?Ln(z)
RE(z) i · IM(z) |
|
-X |
-0 |
+0 |
+X |
|
NAN |
|---|---|---|---|---|---|---|---|
+i · ∞ |
![]() |
|
|
|
|
|
|
+i · Y |
|
|
QNAN+i · QNAN INVALID |
||||
+i · 0 |
|
|
|
|
QNAN+i · QNAN INVALID |
||
-i · 0 |
|
|
|
|
QNAN+i · QNAN INVALID |
||
-i · Y |
|
|
QNAN+i · QNAN INVALID |
||||
-i · ∞ |
![]() |
|
|
|
|
|
|
+i · NAN |
|
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
QNAN+i · QNAN INVALID |
|
QNAN+i · QNAN INVALID |
Notes:
raises INVALID exception when real or imaginary part of the argument is SNAN

