divmod(x1, x2[, out1, out2], / [, out=(None, None)], *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])

Some inconsistencies with the Dask version may exist.

Return element-wise quotient and remainder simultaneously.

np.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 :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.

**kwargs :

For other keyword-only arguments, see the ufunc docs <ufuncs.kwargs> .

Returns

out1 : ndarray

Element-wise quotient resulting from floor division. This is a scalar if both :None:None:`x1` and :None:None:`x2` are scalars.

out2 : ndarray

Element-wise remainder from floor division. This is a scalar if both :None:None:`x1` and :None:None:`x2` are scalars.

This docstring was copied from numpy.divmod.

See Also

floor_divide

Equivalent to Python's // operator.

modf

Equivalent to divmod(x, 1) for positive x with the return values switched.

remainder

Equivalent to Python's % operator.

Examples

This example is valid syntax, but we were not able to check execution

>>> np.divmod(np.arange(5), 3)  # doctest: +SKIP
(array([0, 0, 0, 1, 1]), array([0, 1, 2, 0, 1]))

The divmod function can be used as a shorthand for np.divmod on ndarrays.

This example is valid syntax, but we were not able to check execution

>>> x = np.arange(5)  # doctest: +SKIP
... divmod(x, 3)  # doctest: +SKIP
(array([0, 0, 0, 1, 1]), array([0, 1, 2, 0, 1]))

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

dask.array.ufunc.divmod dask.array.ufunc.modf dask.array.ufunc.floor_divide dask.array.ufunc.remainder

Local connectivity graph

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

---

File: /dask/array/ufunc.py#354
type: <class 'function'>
Commit: