cf.AuxiliaryCoordinate.ceil

AuxiliaryCoordinate.ceil(*args, **kwargs)

The ceiling of the data, element-wise.

The ceiling of x is the smallest integer n, such that

n >= x.

New in version 1.0.

See also

floor, 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 the inplace parameter instead.

Returns

AuxiliaryCoordinate or None

The construct with the ceiling of the 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.ceil().array)
[-1. -1. -1. -1.  0.  1.  2.  2.  2.]
>>> f.ceil(inplace=True)
>>> print(f.array)
[-1. -1. -1. -1.  0.  1.  2.  2.  2.]