.rst .pdf

Contents

modf

Computes the element-wise truncated integral and remaining fractional parts of vector elements.

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.

API

Syntax

Buffer API

namespace oneapi::mkl::vm {

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

}

namespace oneapi::mkl::vm {

sycl::event modf(sycl::queue & exec_queue,
      sycl::buffer<T> & a,
      oneapi::mkl::slice sa,
      sycl::buffer<T> & y,
      oneapi::mkl::slice sy,
      sycl::buffer<T> & z,
      oneapi::mkl::slice sz,
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

}

USM API

namespace oneapi::mkl::vm {

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

}

namespace oneapi::mkl::vm {

sycl::event modf(sycl::queue & exec_queue,
      T const * a,
      oneapi::mkl::slice sa,
      T * y,
      oneapi::mkl::slice sy,
      T * z,
      oneapi::mkl::slice sz,
      std::vector<cl::sycl::event> const & depends = {},
      oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined);

}

modf supports the following precisions and devices:

T	Devices supported
float	Host, CPU, and GPU
double	Host, CPU, and GPU

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 containing the input vector.

sa

Slice selector for a. See Data Types for a description of the oneMKL slice type.

sy

Slice selector for y. See Data Types for a description of the oneMKL slice type.

sz

Slice selector for z. See Data Types for a description of the oneMKL slice type.

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 to the input vector.

sa

Slice selector for a. See Data Types for a description of the oneMKL slice type.

sy

Slice selector for y. See Data Types for a description of the oneMKL slice type.

sz

Slice selector for z. See Data Types for a description of the oneMKL slice type.

depends

Vector of dependent events (to wait for input data to be ready). This is an optional parameter. The default is an empty vector.

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 containing the output vector for truncated integer values.

z

The buffer containing the output vector for remaining fraction parts.

return value (event)

Computation end event.

USM API

y

Pointer to the output vector for truncated integer values.

z

Pointer to the output vector for remaining fraction parts.

return value (event)

Computation end event.

Examples

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

examples/dpcpp/vml/source/vmodf.cpp

rint frac