fmod¶

The fmod function performs element by element computation of the modulus function of vector `a` with respect to vector `b`.

Syntax

Buffer API:

```namespace oneapi::mkl::vm {

sycl::event fmod(
sycl::queue& exec_queue,
std::int64_t n,
sycl::buffer<T,1>& a,
sycl::buffer<T,1>& b,
sycl::buffer<T,1>& y,
oneapi::mkl::vm::mode mode = oneapi::mkl::vm::mode::not_defined,
oneapi::mkl::vm::error_handler<T> errhandler = {});

} // namespace oneapi::mkl::vm
```

USM API:

```namespace oneapi::mkl::vm {

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

} // namespace oneapi::mkl::vm
```

`fmod` supports the following precisions.

T

`float`

`double`

Description

The fmod (a, b) function computes the modulus function of each element of vector `a`, with respect to the corresponding elements of vector `b`:

`ai - bi*trunc(ai/bi)`

In general, the modulus function `fmod (ai, bi)` returns the value `ai - n*bi` 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.

Argument 1

Argument 2

Result

Status code

`a` not NAN

±0

NAN

`oneapi::mkl::vm::status::sing`

±∞

`b` not NAN

NAN

`oneapi::mkl::vm::status::sing`

±0

`b`≠ 0, not NAN

±0

`a` finite

±∞

`a`

NAN

`b`

`a`

NAN

NAN

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 1st input vector of size `n`.

b

The buffer `b` containing 2nd 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::mkl::vm::mode::not_defined`.

errhandler

Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.

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 1st input vector of size `n`.

b

Pointer `b` to the 2nd 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::mkl::vm::mode::not_defined`.

errhandler

Sets local error handling mode for this function call. See the create_error_handler function for arguments and their descriptions. This is an optional parameter. The local error handler is disabled by default.

Output Parameters

Buffer API:

y

The buffer `y` containing the output vector of size `n`.

USM API:

y

Pointer `y` to the output vector of size `n`.

return value (event)

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

Exceptions

For list of generated exceptions please refer to  Exceptions