modf

Computes a truncated integer value and the remaining fraction part for each vector element.

Syntax

Buffer API:

void modf(queue &exec_queue, int64_t n, buffer<T, 1> &a, buffer<T, 1> &y, buffer<T, 1> &z, uint64_t mode = mode::not_defined)

USM API:

event modf(queue &exec_queue, int64_t n, T *a, T *y, T *z, vector_class<event> *depends, uint64_t mode = mode::not_defined)

modf supports the following precisions.

T
float
double

Description

The modf(a) function computes a truncated integer value and the remaining fraction part for each vector element.

Argument	Result 1	Result 2	Error Code
+0	+0	+0
-0	-0	-0
+∞	+∞	+0
-∞	-∞	-0
SNAN	QNAN	QNAN
QNAN	QNAN	QNAN

The modf function does not generate any errors.

Input Parameters

Buffer API:

exec_queue

The queue where the routine should be executed.

n

Specifies the number of elements to be calculated.

a

The buffer a containing input vector of size n.

mode

Overrides the global VM mode setting for this function call. See set_mode function for possible values and their description. This is an optional parameter. The default value is mode::not_defined.

USM API:

exec_queue

The queue where the routine should be executed.

n

Specifies the number of elements to be calculated.

a

Pointer a to the input vector of size n.

depends

Vector of dependent events (to wait for input data to be ready).

mode

Overrides the global VM mode setting for this function call. See the set_mode function for possible values and their description. This is an optional parameter. The default value is mode::not_defined.

Output Parameters

Buffer API:

y

The buffer y containing the output vector of size n for truncated integer values.

z

The buffer z containing the output vector of size n for remaining fraction parts.

USM API:

y

Pointer y to the output vector of size n for truncated integer values.

z

Pointer z to the output vector of size n for remaining fraction parts.

return value (event)

Function end event.

Example

An example of how to use modf can be found in the oneMKL installation directory, under:

examples/sycl/vml/vmodf.cpp

Parent topic: Rounding Functions