numpy.mod#

numpy.mod(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature]) = <ufunc 'remainder'>#

返回逐元素的除法余数。

计算与 floor_divide 函数互补的余数。它等同于 Python 的模运算符 x1 % x2，并且与除数 x2 具有相同的符号。与 np.remainder 等效的 MATLAB 函数是 mod。

警告

这不应与以下混淆：

Python 的 math.remainder 和 C 的 remainder，它们计算 IEEE 余数，是 round(x1 / x2) 的补数。
MATLAB 的 rem 函数或 C 的 % 运算符，它们是 int(x1 / x2) 的补数。

参数:

x1类数组: 被除数数组。
x2类数组: 除数数组。如果 x1.shape != x2.shape，它们必须能广播到共同的形状（这将成为输出的形状）。
outndarray、None 或 ndarray 与 None 的元组，可选: 存储结果的位置。如果提供，它必须具有输入能广播到的形状。如果未提供或为 None，则返回新分配的数组。元组（仅作为关键字参数可能）的长度必须等于输出的数量。
where类数组，可选: 此条件在输入上广播。在条件为 True 的位置，out 数组将设置为 ufunc 结果。在其他位置，out 数组将保留其原始值。请注意，如果通过默认的 out=None 创建未初始化的 out 数组，则其中条件为 False 的位置将保持未初始化。
**kwargs: 有关其他仅限关键字的参数，请参阅 ufunc 文档。

返回:

yndarray: 商 floor_divide(x1, x2) 的逐元素余数。如果 x1 和 x2 都是标量，则结果为标量。

另请参阅

floor_divide: 相当于 Python 的 // 运算符。
divmod: 同时进行向下取整除法和余数计算。
fmod: 相当于 MATLAB 的 rem 函数。
divide, floor

注意

当 x2 为 0 且 x1 和 x2 均为（整数）数组时，返回 0。mod 是 remainder 的别名。

示例

>>> import numpy as np
>>> np.remainder([4, 7], [2, 3])
array([0, 1])
>>> np.remainder(np.arange(7), 5)
array([0, 1, 2, 3, 4, 0, 1])

在 ndarray 上，% 运算符可用作 np.remainder 的简写。

>>> x1 = np.arange(7)
>>> x1 % 5
array([0, 1, 2, 3, 4, 0, 1])