numpy.mod¶

numpy.mod(x1, x2[, out]) = <ufunc 'remainder'>¶

Return element-wise remainder of division.

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. It should not be confused with the Matlab(TM) rem function.

Parameters:

Parameters:	x1 : array_like Dividend array. x2 : array_like Divisor array. out : ndarray, optional Array into which the output is placed. Its type is preserved and it must be of the right shape to hold the output. See doc.ufuncs.
Returns:	y : ndarray The element-wise remainder of the quotient `floor_divide(x1, x2)`. Returns a scalar if both x1 and x2 are scalars.

x1 : array_like

Dividend array.

x2 : array_like

Divisor array.

out : ndarray, optional

Array into which the output is placed. Its type is preserved and it must be of the right shape to hold the output. See doc.ufuncs.

Returns:

y : ndarray

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

See also

floor_divide: Equivalent of Python // operator.
fmod: Equivalent of the Matlab(TM) rem function.

divide, floor

Notes

Returns 0 when x2 is 0 and both x1 and x2 are (arrays of) integers.

Examples

>>> np.remainder([4, 7], [2, 3])
array([0, 1])
>>> np.remainder(np.arange(7), 5)
array([0, 1, 2, 3, 4, 0, 1])