cf.DomainAncillary.floor

DomainAncillary.floor(bounds=True, i=False)

Floor the data array.

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

New in version 1.0.

See also

ceil, rint, trunc

Examples 1:

>>> g = f.floor()

Parameters:

bounds: optional

Ignored.

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