numpy.ufunc.reduce#

方法

ufunc.reduce(array, axis=0, dtype=None, out=None, keepdims=False, initial=<no value>, where=True)#

通过沿一个轴应用 ufunc 来将 array 的维度减一。

设 \(array.shape = (N_0, ..., N_i, ..., N_{M-1})\)。那么 \(ufunc.reduce(array, axis=i)[k_0, ..,k_{i-1}, k_{i+1}, .., k_{M-1}]\) = 迭代 j 于 \(range(N_i)\)，对每个 \(array[k_0, ..,k_{i-1}, j, k_{i+1}, .., k_{M-1}]\) 累积应用 ufunc 的结果。对于一维数组，reduce 产生的结果等同于

r = op.identity # op = ufunc
for i in range(len(A)):
  r = op(r, A[i])
return r

例如，add.reduce() 等同于 sum()。

参数:
arrayarray_like

要进行操作的数组。

axisNone 或 int 或 int 元组，可选

执行归约的轴。默认值（axis = 0）是对输入数组的第一个维度执行归约。 axis 可以为负数，在这种情况下，它从最后一个轴计数到第一个轴。

如果此值为 None，则对所有轴执行归约。如果此值为整数元组，则对多个轴执行归约，而不是像之前那样对单个轴或所有轴执行归约。

对于既非交换也非结合的运算，对多个轴进行归约是未定义的。 ufuncs 当前不会在此情况下引发异常，但将来可能会。

dtype数据类型代码，可选

用于执行操作的数据类型。如果提供了 out，则默认为 out 的数据类型，否则默认为 array 的数据类型（尽管为了保持精度，某些情况下会向上转型，例如整数或布尔输入的 numpy.add.reduce）。

outndarray，None，…，或 ndarray 和 None 的元组，可选

存储结果的位置。如果未提供或为 None，则返回一个新分配的数组。如果作为关键字参数传递，可以为 Ellipses (out=...) 以确保即使结果是 0 维也能返回一个数组（这对于对象 dtype 特别有用），或为一个单元素元组（后者与 ufunc.__call__ 保持一致）。

版本 2.3 中新增： 支持 out=...。

keepdimsbool，可选

如果设置为 True，则被归约的轴将作为大小为一的维度保留在结果中。使用此选项，结果将与原始 array 正确广播。

initial标量，可选

用于开始归约的值。如果 ufunc 没有身份元素或 dtype 为 object，则默认为 None - 否则默认为 ufunc.identity。如果给出 None，则使用归约的第一个元素，并且如果归约为空，则会引发错误。

wherearray_like of bool，可选

一个布尔数组，它被广播以匹配 array 的维度，并选择要包含在归约中的元素。请注意，对于像 minimum 这样没有定义身份元素的 ufuncs，还需要传递 initial。

返回:
rndarray

归约后的数组。如果提供了 out，则 r 是它的引用。

示例

>>> import numpy as np
>>> np.multiply.reduce([2,3,5])
30

多维数组示例

>>> X = np.arange(8).reshape((2,2,2))
>>> X
array([[[0, 1],
        [2, 3]],
       [[4, 5],
        [6, 7]]])
>>> np.add.reduce(X, 0)
array([[ 4,  6],
       [ 8, 10]])
>>> np.add.reduce(X) # confirm: default axis value is 0
array([[ 4,  6],
       [ 8, 10]])
>>> np.add.reduce(X, 1)
array([[ 2,  4],
       [10, 12]])
>>> np.add.reduce(X, 2)
array([[ 1,  5],
       [ 9, 13]])

您可以使用 initial 关键字参数来使用不同的值初始化归约，并使用 where 来选择要包含的特定元素

>>> np.add.reduce([10], initial=5)
15
>>> np.add.reduce(np.ones((2, 2, 2)), axis=(0, 2), initial=10)
array([14., 14.])
>>> a = np.array([10., np.nan, 10])
>>> np.add.reduce(a, where=~np.isnan(a))
20.0

允许对空数组进行归约，尽管它们通常会失败，即对于没有身份元素的 ufuncs。

>>> np.minimum.reduce([], initial=np.inf)
inf
>>> np.minimum.reduce([[1., 2.], [3., 4.]], initial=10., where=[True, False])
array([ 1., 10.])
>>> np.minimum.reduce([])
Traceback (most recent call last):
    ...
ValueError: zero-size array to reduction operation minimum which has no identity
在此页面