modf

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

Syntax

Buffer API:

namespace oneapi::math::vm {

sycl::event modf(
        sycl::queue& exec_queue,
        std::int64_t n,
        sycl::buffer<T,1>& a,
        sycl::buffer<T,1>& y,
        sycl::buffer<T,1>& z,
        oneapi::math::vm::mode mode = oneapi::math::vm::mode::not_defined);

} // namespace oneapi::math::vm

USM API:

namespace oneapi::math::vm {

sycl::event modf(
        sycl::queue& exec_queue,
        std::int64_t n,
        const T *a,
        T* y,
        T* z,
        std::vector<sycl::event> const & depends = {},
        oneapi::math::vm::mode mode = oneapi::math::vm::mode::not_defined);

} // namespace oneapi::math::vm

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.

\[ \begin{align}\begin{aligned}\begin{split}a_i \geq 0, \begin{cases} y_i = \lfloor a_i \rfloor \\ z_i = a_i - \lfloor a_i \rfloor \end{cases}\end{split}\\\begin{split}a_i < 0, \begin{cases} y_i = \lceil a_i \rceil \\ z_i = a_i - \lceil a_i \rceil \end{cases}\end{split}\end{aligned}\end{align} \]

Argument	Result 1	Result 2	Status 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 oneapi::math::vm::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 oneapi::math::vm::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)

Event, signifying availability of computed output and status code(s).

Exceptions

For list of generated exceptions please refer to  Exceptions

Parent topic: VM Mathematical Functions