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)\) 的结果,累积地将 ufunc 应用于每个 \(array[k_0, ..,k_{i-1}, j, k_{i+1}, .., k_{M-1}]\)。对于一维数组,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 可以为负数,在这种情况下,它从最后一个轴到第一个轴进行计数。

版本 1.7.0 中的新内容。

如果为 None,则在所有轴上执行约简。如果为 int 元组,则在多个轴上执行约简,而不是像以前那样在一个轴或所有轴上执行。

对于非交换或非结合运算,在多个轴上进行约简没有明确的定义。ufunc 目前不会在此情况下引发异常,但将来可能会这样做。

dtype数据类型代码,可选

用于执行运算的数据类型。如果提供了 out,则默认为 out 的数据类型;否则默认为 array 的数据类型(尽管在某些情况下会向上转换以保留精度,例如整数或布尔输入的 numpy.add.reduce)。

outndarray、None 或 ndarray 和 None 的元组,可选

存储结果的位置。如果未提供或为 None,则返回一个新分配的数组。为了与 ufunc.__call__ 保持一致,如果作为关键字给出,则可以使用 1 元素元组将其包装起来。

版本 1.13.0 中的更改: 元组允许用于关键字参数。

keepdimsbool,可选

如果将其设置为 True,则约简的轴将作为大小为 1 的维度保留在结果中。使用此选项,结果将针对原始 array 正确广播。

版本 1.7.0 中的新内容。

initial标量,可选

用于开始约简的值。如果 ufunc 没有恒等式或 dtype 为对象,则默认为 None - 否则默认为 ufunc.identity。如果给定 None,则使用约简的第一个元素,如果约简为空,则抛出错误。

版本 1.15.0 中的新内容。

wherebool 的 array_like,可选

一个布尔数组,其广播以匹配 array 的维度,并选择要包含在约简中的元素。请注意,对于像 minimum 这样未定义恒等式的 ufunc,必须同时传入 initial

版本 1.17.0 中的新内容。

返回值:
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

允许在通常会失败的空数组上进行约简,即对于没有恒等式的 ufunc。

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