jax.numpy.floor_divide#

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

Return the largest integer smaller or equal to the division of the inputs.

LAX-backend implementation of numpy.floor_divide().

Original docstring below.

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.

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