nlcpy.floor

nlcpy.floor = <ufunc 'nlcpy_floor'>

Returns the floor of the input, element-wise.

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

Parameters

xarray_like: Input arrays or scalars.
outndarray or None, 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.
wherearray_like, 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 section Optional Keyword Arguments.

Returns

yndarray: The floor of each element in x. If x is a scalar, this function returns the result as a 0-dimension ndarray.

See also

ceil: Returns the ceiling of the input, element-wise.
trunc: Returns the truncated value of the input, element-wise.
rint: Computes the element-wise nearest integer.

Note

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

Examples

>>> import nlcpy as vp
>>> a = vp.array([-1.7, -1.5, -0.2, 0.2, 1.5, 1.7, 2.0])
>>> vp.floor(a)
array([-2., -2., -1.,  0.,  1.,  1.,  2.])