rint

Computes a rounded integer value in the current rounding mode.

Syntax

Buffer API:

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

USM API:

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

rint supports the following precisions and devices:

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

Description

The rint(a) function computes a rounded floating-point integer value using the current rounding mode for each vector element.

The rounding mode affects the results computed for inputs that fall between consecutive integers. For example:

Special Values for Real Function rint(a)
Argument Result Error Code
+0 +0  
-0 -0  
+ +  
- -  
QNAN QNAN  
SNAN QNAN  

The rint 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.

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 rintcan be found in the Intel® oneMKL installation directory, under:

examples/sycl/vml/vrint.cpp