nums.numpy.floor
-
nums.numpy.floor(x, out=None, where=True, **kwargs)[source] Return the floor of the input, element-wise.
This docstring was copied from numpy.floor.
Some inconsistencies with the NumS version may exist.
The floor of the scalar x is the largest integer i, such that i <= x. It is often denoted as :math:`lfloor x
floor`.
- xBlockArray
Input data.
- outBlockArray, None, or optional
A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.
- whereBlockArray, optional
This condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default
out=None, locations within it where the condition is False will remain uninitialized.- **kwargs
For other keyword-only arguments, see the ufunc docs.
- yBlockArray or scalar
The floor of each element in x.
ceil, trunc, rint
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.The doctests shown below are copied from NumPy. They won’t show the correct result until you operate
get().>>> a = nps.array([-1.7, -1.5, -0.2, 0.2, 1.5, 1.7, 2.0]) >>> nps.floor(a).get() array([-2., -2., -1., 0., 1., 1., 2.])
- Return type