jax.numpy.floor

jax.numpy.floor(x)

Return the floor of the input, element-wise.

LAX-backend implementation of floor(). Original docstring below.

floor(x, /, out=None, *, where=True, casting=’same_kind’, order=’K’, dtype=None, subok=True[, signature, extobj])

The floor of the scalar x is the largest integer i, such that i <= x. It is often denoted as \(\lfloor x \rfloor\).

Parameters

x (array_like) – Input data.

Returns

y – The floor of each element in x. This is a scalar if x is a scalar.

Return type

ndarray or scalar

See also

ceil(), trunc(), rint()

Notes

Some spreadsheet programs calculate the “floor-towards-zero”, in other words floor(-2.5) == -2. NumPy instead uses the definition of floor where floor(-2.5) == -3.

Examples

>>> a = np.array([-1.7, -1.5, -0.2, 0.2, 1.5, 1.7, 2.0])
>>> np.floor(a)
array([-2., -2., -1.,  0.,  1.,  1.,  2.])