remainder¶

Performs element by element computation of the remainder function on the elements of vector a and the corresponding elements of vector b.

Syntax

Buffer API:

void remainder(queue &exec_queue, int64_t n, buffer<T, 1> &a, buffer<T, 1> &b, buffer<T, 1> &y, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {})¶

USM API:

event remainder(queue &exec_queue, int64_t n, T *a, T *b, T *y, vector_class<event> *depends, uint64_t mode = mode::not_defined, error_handler<T> errhandler = {})¶

remainder supports the following precisions.

T
`float`
`double`

Description

The remainder(a) function computes the remainder of each element of vector a, with respect to the corresponding elements of vector b: compute the values of n such that

n = ai - n*bi

where n is the integer nearest to the exact value of a_i/b_i. If two integers are equally close to a_i/b_i, n is the even one. If n is zero, it has the same sign as a_i.

Argument 1	Argument 2	Result	VM Error Status
`a` not NAN	±0	NAN	status::errdom
±∞	`b` not NAN	NAN
±0	`b`≠ 0, not NAN	±0
`a` finite	±∞	`a`
NAN	`b`	NAN
`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 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 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): Function end event.

Example

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

examples/sycl/vml/vremainder.cpp

Parent topic: Arithmetic Functions