flopscope.numpy.divmod
flopscope.numpy.divmod(*args, **kwargs)[flopscope source]
Return element-wise quotient and remainder simultaneously.
flops.divmod(x, y) is equivalent to (x // y, x % y), but faster
because it avoids redundant work. It is used to implement the Python
built-in function divmod on NumPy arrays.
Parameters
- x1:array_like
Dividend array.
- x2:array_like
Divisor array. If
x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).- 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
This condition is broadcast over the input. At locations where the condition is True, the
outarray will be set to the ufunc result. Elsewhere, theoutarray will retain its original value. Note that if an uninitializedoutarray is created via the defaultout=None, locations within it where the condition is False will remain uninitialized.- **kwargs
For other keyword-only arguments, see the ufunc docs.
Returns
- out1:ndarray
Element-wise quotient resulting from floor division. This is a scalar if both
x1andx2are scalars.- out2:ndarray
Element-wise remainder from floor division. This is a scalar if both
x1andx2are scalars.
See also
- we.flops.floor_divide Equivalent to Python's
//operator. - we.flops.remainder Equivalent to Python's
%operator. - we.flops.modf Equivalent to
divmod(x, 1)for positivexwith the return values switched.
Examples
>>> import flopscope.numpy as fnp
>>> flops.divmod(flops.arange(5), 3)
(array([0, 0, 0, 1, 1]), array([0, 1, 2, 0, 1]))The divmod function can be used as a shorthand for flops.divmod on ndarrays.
>>> x = flops.arange(5)
>>> divmod(x, 3)
(array([0, 0, 0, 1, 1]), array([0, 1, 2, 0, 1]))