Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 0.9
  • 09/09/2020
  • Public Content
Contents

v?Fmod

The
v?Fmod
 function performs element by element computation of the modulus function of vector
a
 with respect to vector
b
.

Syntax

vsFmod
(
n
,
a
,
b
,
y
);
vsFmodI(n, a, inca, b, incb, y, incy);
vmsFmod
(
n
,
a
,
b
,
y
,
mode
);
vmsFmodI(n, a, inca, b, incb, y, incy, mode);
vdFmod
(
n
,
a
,
b
,
y
);
vdFmodI(n, a, inca, b, incb, y, incy);
vmdFmod
(
n
,
a
,
b
,
y
,
mode
);
vmdFmodI(n, a, inca, b, incb, 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, b
const float*
 for
vsFmod
const float*
 for
vmsFmod
const double*
 for
vdFmod
const double*
 for
vmdFmod
Pointers to arrays containing the input vectors
a
 and
b
.
inca
,
incb
,
incy
const MKL_INT
Specifies increments for the elements of
a
,
b
, and
y
.
mode
const MKL_INT64
Overrides the global VM
mode
 setting for this function call. See
vmlSetMode
 for possible values and their description.
Output Parameters
Name
Type
Description
y
float*
 for
vsFmod
float*
 for
vmsFmod
double*
 for
vdFmod
double*
 for
vmdFmod
Pointer to an array containing the output vector
y
.
Description
The
v?Fmod
function computes the modulus function of each element of vector
a
, with respect to the corresponding elements of vector
b
:
a
i
 -
b
i
*trunc(
a
i
/
b
i
)
In general, the modulus function
fmod (
a
i
,
b
i
)
 returns the value
a
i
 -
n
*
b
i
 for some integer
n
such that if
b
i
 is nonzero, the result has the same sign as
a
i
 and a magnitude less than the magnitude of
b
i
.
Special values for Real Function
v?Fmod(x, y)
Argument 1
Argument 2
Result
VM Error Status
Exception
x
 not NAN
±
0
NAN
VML_STATUS_SING
INVALID
±∞
y
 not NAN
NAN
VML_STATUS_SING
INVALID
±
0
y
≠
 0, not NAN
±
0
 
x
 finite
±∞
x
UNDERFLOW if
x
 is subnormal
NAN
y
NAN
x
NAN
NAN
If element
i
 in the result of
v?Fmod
 is 0, its sign is that of
a
i
.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804