jax.numpy.floor_divide

jax.numpy.floor_divide(x1, x2)[source]

Return the largest integer smaller or equal to the division of the inputs. It is equivalent to the Python // operator and pairs with the Python % (remainder), function so that a = a % b + b * (a // b) up to roundoff.

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

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

Parameters
  • x1 (array_like) – Numerator.

  • x2 (array_like) – Denominator. If x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

  • 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.

Returns

y – y = floor(x1/x2) This is a scalar if both x1 and x2 are scalars.

Return type

ndarray

See also

remainder()

Remainder complementary to floor_divide.

divmod()

Simultaneous floor division and remainder.

divide()

Standard division.

floor()

Round a number to the nearest integer toward minus infinity.

ceil()

Round a number to the nearest integer toward infinity.

Examples

>>> np.floor_divide(7,3)
2
>>> np.floor_divide([1., 2., 3., 4.], 2.5)
array([ 0.,  0.,  1.,  1.])