#### Previous topic

numpy.fmod

#### Next topic

numpy.modf

# numpy.mod

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

  Return element-wise remainder of division.

  Computes `x1 - floor(x1 / x2) * x2`, the result has the same sign as the divisor x2. It is equivalent to the Python modulus operator `x1 % x2` and should not be confused with the Matlab(TM) `rem` function.

  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 remainder of the quotient `x1/x2`, element-wise. Returns a scalar if both x1 and x2 are scalars.

  See also

  `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])