v?Fmod

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 6/24/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-D88D4F44-4CFE-4CD0-81A2-028E04E537AF

View Details

v?Fmod

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

Syntax

vhFmod (n, a, b, y);

vhFmodI(n, a, inca, b, incb, y, incy);

vmhFmod (n, a, b, y, mode);

vmhFmodI(n, a, inca, b, incb, y, incy, mode);

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 _Float16* for vhFmod const float* for vsFmod const _Float16* for vmhFmod 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`	_Float16* for vhFmod float* for vsFmod _Float16* for vmhFmod float* for vmsFmod double* for vdFmod double* for vmdFmod	Pointer to an array containing the output vector `y`.

Name

Type

Description

y

_Float16* for vhFmod

float* for vsFmod

_Float16* for vmhFmod

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

NOTE:

If element i in the result of v?Fmod is 0, its sign is that of a_i.

Parent topic: Arithmetic Functions

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

v?Fmod

Syntax

Include Files

Input Parameters

Output Parameters

Description

See Also