cf.AuxiliaryCoordinate.floor

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

Floor the data array, element-wise.

The floor of x is the largest integer n, such that n <= x.

New in version 1.0.

See also

ceil, rint, 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 floored 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.floor().array)
[-2. -2. -2. -1.  0.  1.  1.  1.  1.]
>>> f.floor(inplace=True)
>>> print(f.array)
[-2. -2. -2. -1.  0.  1.  1.  1.  1.]