Python numpy mod用法及代码示例

本文简要介绍 python 语言中 numpy.mod 的用法。

用法:

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

返回除法的元素余数。

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

警告

这不应与以下内容混淆：

• Python 3.7 的 math.remainder 和 C 的 remainder 计算 IEEE 余数，它们是 round(x1 / x2) 的补码。

• MATLAB rem 函数和/或 C % 运算符，它是对 int(x1 / x2) 的补充。

参数：

x1： array_like

股息数组。

x2： array_like

除数数组。如果 x1.shape != x2.shape ，它们必须可以广播到一个公共形状(成为输出的形状)。

out： ndarray，None，或 ndarray 和 None 的元组，可选

存储结果的位置。如果提供，它必须具有输入广播到的形状。如果未提供或 None，则返回一个新分配的数组。元组(只能作为关键字参数)的长度必须等于输出的数量。

where： 数组，可选

此条件通过输入广播。在条件为真的位置，out数组将设置为 ufunc 结果。在其他地方，out数组将保留其原始值。请注意，如果未初始化out数组是通过默认创建的out=None，其中条件为 False 的位置将保持未初始化状态。

**kwargs：

对于其他仅关键字参数，请参阅 ufunc 文档。

返回：

y： ndarray

商的逐元素余数floor_divide(x1, x2).如果两者都是标量x1和x2是标量。

注意：

当以下情况时返回 0x2是 0 并且两者都是x1和x2是整数(数组)。mod是一个别名remainder.

例子：

>>> 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])