jax.numpy.mod¶
-
jax.numpy.
mod
(x1, x2)¶ Return element-wise remainder of division.
LAX-backend implementation of
remainder()
. Original docstring below.remainder(x1, x2, /, out=None, *, where=True, casting=’same_kind’, order=’K’, dtype=None, subok=True[, signature, extobj])
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
ismod
.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 toround(x1 / x2)
.The MATLAB
rem
function and or the C%
operator which is the complement toint(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
See also
floor_divide()
Equivalent of Python
//
operator.divmod()
Simultaneous floor division and remainder.
fmod()
Equivalent of the MATLAB
rem
function.
Notes
Returns 0 when x2 is 0 and both x1 and x2 are (arrays of) integers.
mod
is an alias ofremainder
.Examples
>>> np.remainder([4, 7], [2, 3]) array([0, 1]) >>> np.remainder(np.arange(7), 5) array([0, 1, 2, 3, 4, 0, 1])