numpy.divmod¶

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

Return element-wise quotient and remainder simultaneously.

New in version 1.13.0.

np.divmod(x,y) is equivalent to(x//y,x%y), but fasterbecause it avoids redundant work. It is used to implement the Pythonbuilt-in functiondivmod on NumPy arrays.

Parameters:

x1:array_like Dividend array. x2:array_like Divisor array. out:ndarray, None, or tuple of ndarray and None, optional A location into which the result is stored. If provided, it must havea shape that the inputs broadcast to. If not provided orNone,a freshly-allocated array is returned. A tuple (possible only as akeyword 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, valuesof False indicate to leave the value in the output alone. **kwargs For other keyword-only arguments, see theufunc docs.

Returns:

out1:ndarray Element-wise quotient resulting from floor division.This is a scalar if bothx1 andx2 are scalars. out2:ndarray Element-wise remainder from floor division.This is a scalar if bothx1 andx2 are scalars.

See also

floor_divide

Equivalent to Python’s// operator.

remainder

Equivalent to Python’s% operator.

modf

Equivalent todivmod(x,1) for positivex with the return values switched.

Examples

>>>np.divmod(np.arange(5),3)(array([0, 0, 0, 1, 1]), array([0, 1, 2, 0, 1]))