jax.numpy.divmod

Contents

jax.numpy.divmod#

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

Return element-wise quotient and remainder simultaneously.

LAX-backend implementation of numpy.divmod().

Original docstring below.

Added in version 1.13.0.

np.divmod(x, y) is equivalent to (x // y, x % y), but faster because it avoids redundant work. It is used to implement the Python built-in function divmod on NumPy arrays.

Parameters:
  • x1 (array_like) – Dividend array.

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

Returns:

  • out1 (ndarray) – Element-wise quotient resulting from floor division. This is a scalar if both x1 and x2 are scalars.

  • out2 (ndarray) – Element-wise remainder from floor division. This is a scalar if both x1 and x2 are scalars.

Return type:

tuple[Array, Array]