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 :None:None:`x2`
. The MATLAB function equivalent to np.remainder
is mod
.
This should not be confused with:
Python 3.7's :None:None:`math.remainder`
and C's remainder
, which computes the IEEE remainder, which are the complement to round(x1 / x2)
.
The MATLAB rem
function and or the C %
operator which is the complement to int(x1 / x2)
.
Returns 0 when :None:None:`x2`
is 0 and both x1
and :None:None:`x2`
are (arrays of) integers. mod
is an alias of remainder
.
Dividend array.
Divisor array. If x1.shape != x2.shape
, they must be broadcastable to a common shape (which becomes the shape of the output).
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.
This condition is broadcast over the input. At locations where the condition is True, the :None:None:`out`
array will be set to the ufunc result. Elsewhere, the :None:None:`out`
array will retain its original value. Note that if an uninitialized :None:None:`out`
array is created via the default out=None
, locations within it where the condition is False will remain uninitialized.
For other keyword-only arguments, see the ufunc docs <ufuncs.kwargs>
.
The element-wise remainder of the quotient floor_divide(x1, x2)
. This is a scalar if both x1
and :None:None:`x2`
are scalars.
Returns the element-wise remainder of division.
divmod
Simultaneous floor division and remainder.
floor_divide
Equivalent of Python //
operator.
fmod
Equivalent of the MATLAB rem
function.
>>> np.remainder([4, 7], [2, 3]) array([0, 1])This example is valid syntax, but we were not able to check execution
>>> np.remainder(np.arange(7), 5) array([0, 1, 2, 3, 4, 0, 1])
The %
operator can be used as a shorthand for np.remainder
on ndarrays.
>>> x1 = np.arange(7)See :
... x1 % 5 array([0, 1, 2, 3, 4, 0, 1])
The following pages refer to to this document either explicitly or contain code examples using this.
numpy.ma.core.floor_divide
numpy.ma.core.fmod
Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.
Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)
SVG is more flexible but power hungry; and does not scale well to 50 + nodes.
All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them