rint

Computes a rounded integer value in the current rounding mode.

Syntax

Buffer API:

namespace oneapi::mkl::vm {

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

} // namespace oneapi::mkl::vm

USM API:

namespace oneapi::mkl::vm {

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

} // namespace oneapi::mkl::vm

rint supports the following precisions.

T

float

double

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:

  • f(0.5) = 0, for rounding modes set to round to nearest round

    toward zero or to minus infinity.

  • f(0.5) = 1, for rounding modes set to plus infinity.

  • f(-1.5) = -2, for rounding modes set to round to nearest or to

    minus infinity.

  • f(-1.5) = -1, for rounding modes set to round toward zero or to

    plus infinity.

Argument

Result

Status 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 oneapi::mkl::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::mkl::vm::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)

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

remainder round