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

Some inconsistencies with the Dask version may exist.

Return the floor of the input, element-wise.

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

Notes

Some spreadsheet programs calculate the "floor-towards-zero", where floor(-2.5) == -2 . NumPy instead uses the definition of floor where :None:None:`floor(-2.5) == -3`. The "floor-towards-zero" function is called fix in NumPy.

Parameters

x : array_like

Input data.

out : ndarray, None, or tuple of ndarray and 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.

where : array_like, optional

This condition is broadcast over the input. At locations where the condition is True, the :None:None:`out` array will be set to the ufunc result. Elsewhere, the :None:None:`out` array will retain its original value. Note that if an uninitialized :None:None:`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 <ufuncs.kwargs> .

Returns

y : ndarray or scalar

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

This docstring was copied from numpy.floor.

See Also

ceil

fix

rint

trunc

Examples

This example is valid syntax, but we were not able to check execution

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

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

dask.array.ufunc.floor_divide dask.array.ufunc.trunc dask.array.ufunc.ceil dask.array.ufunc.floor dask.array.ufunc.rint dask.array.routines.around dask.array.ufunc.remainder

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /dask/array/ufunc.py#None
type: <class 'dask.array.ufunc.ufunc'>
Commit: