cf.DomainAncillary.rint

DomainAncillary.rint(i=False)

round data array.

The scalar x is rounded to the nearest integer i.

New in version 1.0.

See also

ceil, floor, trunc

Examples 1:

Create a new domain ancillary with rounded data:

>>> g = f.rint()

Parameters:

i: bool, optional

If True then update the domain ancillary in place. By default a new domain ancillary is created. In either case, a domain ancillary is returned.

Returns:

out

: cf.DomainAncillary

The domain ancillary with rounded data array values.

Examples 2:

>>> 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.]
>>> print f.array
[-1.9 -1.5 -1.1 -1.   0.   1.   1.1  1.5  1.9]
>>> print f.rint(i=True).array
[-2. -2. -1. -1.  0.  1.  1.  2.  2.]
>>> print f.array
[-2. -2. -1. -1.  0.  1.  1.  2.  2.]