numpy.fmod
-
numpy.fmod(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj]) = <ufunc 'fmod'>
-
Return the element-wise remainder of division.
This is the NumPy implementation of the C library function fmod, the remainder has the same sign as the dividend
x1
. It is equivalent to the Matlab(TM)rem
function and should not be confused with the Python modulus operatorx1 % x2
.Parameters: -
x1 : array_like
-
Dividend.
-
x2 : array_like
-
Divisor.
-
out : ndarray, None, or tuple of ndarray and None, optional
-
A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or
None
, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs. -
where : array_like, optional
-
Values of True indicate to calculate the ufunc at that position, values of False indicate to leave the value in the output alone.
- **kwargs
-
For other keyword-only arguments, see the ufunc docs.
Returns: -
y : array_like
-
The remainder of the division of
x1
byx2
. This is a scalar if bothx1
andx2
are scalars.
Notes
The result of the modulo operation for negative dividend and divisors is bound by conventions. For
fmod
, the sign of result is the sign of the dividend, while forremainder
the sign of the result is the sign of the divisor. Thefmod
function is equivalent to the Matlab(TM)rem
function.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]])
-
© 2005–2019 NumPy Developers
Licensed under the 3-clause BSD License.
https://docs.scipy.org/doc/numpy-1.16.1/reference/generated/numpy.fmod.html