dpnp.floor

dpnp.floor(x, out=None, where=True, order='K', dtype=None, subok=True, **kwargs)

Returns the floor for each element x_i for input array x.

The floor of x_i is the largest integer n, such that n <= x_i.

For full documentation refer to numpy.floor.

Parameters:

  • x ({dpnp.ndarray, usm_ndarray}) -- Input array, expected to have a real-valued data type.

  • out ({None, dpnp.ndarray, usm_ndarray}, optional) -- Output array to populate. Array must have the correct shape and the expected data type. Default: None.

  • order ({"C", "F", "A", "K"}, optional) -- Memory layout of the newly output array, if parameter out is None. Default: "K".

Returns:

out -- An array containing the element-wise floor.

Return type:

dpnp.ndarray

Limitations

Parameters where and subok are supported with their default values. Keyword argument kwargs is currently unsupported. Otherwise NotImplementedError exception will be raised.

See also

dpnp.ceil

Compute the ceiling of the input, element-wise.

dpnp.trunc

Return the truncated value of the input, element-wise.

dpnp.rint

Round elements of the array to the nearest integer.

dpnp.fix

Round to nearest integer towards zero, element-wise.

Notes

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

Examples

>>> import dpnp as np
>>> a = np.array([-1.7, -1.5, -0.2, 0.2, 1.5, 1.7, 2.0])
>>> np.floor(a)
array([-2.0, -2.0, -1.0, 0.0, 1.0, 1.0, 2.0])