SciPy

numpy.fmod

numpy.fmod(x1, x2[, out]) = <ufunc 'fmod'>

Return the element-wise remainder of division.

This is the NumPy implementation of the Python modulo operator %.

Parameters :

x1 : array_like

Dividend.

x2 : array_like

Divisor.

Returns :

y : array_like

The remainder of the division of x1 by x2.

See also

remainder
Modulo operation where the quotient is floor(x1/x2).

divide

Notes

The result of the modulo operation for negative dividend and divisors is bound by conventions. In fmod, the sign of the remainder is the sign of the dividend. In remainder, the sign of the divisor does not affect the sign of the result.

Examples

>>> np.fmod([-3, -2, -1, 1, 2, 3], 2)
array([-1,  0, -1,  1,  0,  1])
>>> np.remainder([-3, -2, -1, 1, 2, 3], 2)
array([1, 0, 1, 1, 0, 1])
>>> np.fmod([5, 3], [2, 2.])
array([ 1.,  1.])
>>> a = np.arange(-3, 3).reshape(3, 2)
>>> a
array([[-3, -2],
       [-1,  0],
       [ 1,  2]])
>>> np.fmod(a, [2,2])
array([[-1,  0],
       [-1,  0],
       [ 1,  0]])

Previous topic

numpy.floor_divide

Next topic

numpy.mod