jax.numpy.mod#

jax.numpy.mod(x1, x2, /)#

Returns the element-wise remainder of division.

LAX-backend implementation of numpy.remainder().

Original docstring below.

Computes the remainder complementary to the floor_divide function. It is equivalent to the Python modulus operator``x1 % x2`` and has the same sign as the divisor x2. The MATLAB function equivalent to np.remainder is mod.

Warning

This should not be confused with:

  • Python 3.7’s math.remainder and C’s remainder, which computes the IEEE remainder, which are the complement to round(x1 / x2).

  • The MATLAB rem function and or the C % operator which is the complement to int(x1 / x2).

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:

y – The element-wise remainder of the quotient floor_divide(x1, x2). This is a scalar if both x1 and x2 are scalars.

Return type:

ndarray