cf.AuxiliaryCoordinate.rint

AuxiliaryCoordinate.rint(bounds=True, inplace=False, i=False)[source]

Round the data to the nearest integer, element-wise.

New in version 1.0.

See also

ceil, floor, trunc

Parameters
bounds: bool, optional

If False then do not alter any bounds. By default any bounds are also altered.

inplace: bool, optional

If True then do the operation in-place and return None.

i: deprecated at version 3.0.0

Use inplace parameter instead.

Returns

The construct with rounded data. If the operation was in-place then None is returned.

Examples:

>>> print(f.array)
[-1.9 -1.5 -1.1 -1.   0.   1.   1.1  1.5  1.9]
>>> print(f.rint().array)
[-2. -2. -1. -1.  0.  1.  1.  2.  2.]
>>> f.rint(inplace=True)
>>> print(f.array)
[-2. -2. -1. -1.  0.  1.  1.  2.  2.]