Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

v?Rint

Computes a rounded integer value in the current rounding mode.

Syntax

vsRint( n, a, y );

vsRintI(n, a, inca, y, incy);

vmsRint( n, a, y, mode );

vmsRintI(n, a, inca, y, incy, mode);

vdRint( n, a, y );

vdRintI(n, a, inca, y, incy);

vmdRint( n, a, y, mode );

vmdRintI(n, a, inca, y, incy, mode);

Include Files

  • mkl.h

Input Parameters

Name

Type

Description

n

const MKL_INT

Specifies the number of elements to be calculated.

a

const float* for vsRint, vmsRint

const double* for vdRint, vmdRint

Pointer to an array that contains the input vector a.

inca, incy

const MKL_INT

Specifies increments for the elements of a and y.

mode

const MKL_INT64

Overrides global VM mode setting for this function call. See vmlSetMode for possible values and their description.

Output Parameters

Name

Type

Description

y

float* for vsRint, vmsRint

double* for vdRint, vmdRint

Pointer to an array that contains the output vector y.

Description

The v?Rint 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.

Special Values for Real Function v?Rint(x)
Argument Result Exception
+0 +0  
-0 -0  
+ +  
- -  
SNAN QNAN INVALID
QNAN QNAN