Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 2021.1
  • 12/04/2020
  • Public Content
Contents

v?Ln

Computes natural logarithm of vector elements.

Syntax

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 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
 for possible values and their description.
Output Parameters
Name
Type
Description
y
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
·
π
/2
+
∞
+i
·
π
/2
+
∞
+i
·
π
/2
+
∞
+i
·
π
/2
+
∞
+i
·
π
/4
+
∞
+i
·
QNAN
+i
·
Y
+
∞
+i
·
π
+
∞
+i
·
0
QNAN+i
·
QNAN
INVALID
+i
·
0
+
∞
+i
·
π
-
∞
+i
·
π
 ZERODIVIDE
-
∞
+i
·
0 ZERODIVIDE
+
∞
+i
·
0
QNAN+i
·
QNAN
INVALID
-i
·
0
+
∞
-i
·
π
-
∞
-i
·
π
 ZERODIVIDE
-
∞
-i
·
0 ZERODIVIDE
+
∞
-i
·
0
QNAN+i
·
QNAN
INVALID
-i
·
Y
+
∞
-i
·
π
+
∞
-i
·
0
QNAN+i
·
QNAN
INVALID
-i
·
∞
+
∞
-i
·
π
/2
+
∞
-i
·
π
/2
+
∞
-i
·
π
/2
+
∞
-i
·
π
/2
+
∞
-i
·
π
/4
+
∞
+i
·
QNAN
+i
·
NAN
+
∞
+i
·
QNAN
QNAN+i
·
QNAN
INVALID
QNAN+i
·
QNAN
INVALID
QNAN+i
·
QNAN
INVALID
QNAN+i
·
QNAN
INVALID
+
∞
+i
·
QNAN
QNAN+i
·
QNAN
INVALID
Notes:
  • raises
    INVALID
     exception when real or imaginary part of the argument is
    SNAN

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.