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 3.7 的 math.remainder 和 C 的 remainder,计算 IEEE 余数,这是 round(x1 / x2) 的补码.
MATLAB 的 rem 函数和或 C 语言的 % 运算符,这是 int(x1 / x2) 的补码.

参数:

x1array_like: 股息数组.
x2array_like: 除数数组.如果 x1.shape != x2.shape,它们必须能够广播到一个共同的形状（这将成为输出形状）.
outndarray, None, 或 ndarray 和 None 的元组, 可选: 存储结果的位置.如果提供,它必须具有输入广播到的形状.如果未提供或为 None,则返回一个新分配的数组.元组（只能作为关键字参数）的长度必须等于输出的数量.
wherearray_like, 可选: 这个条件通过输入进行广播.在条件为 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])

% 运算符可以用作 ndarrays 上 np.remainder 的简写.

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