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}]\) = 通过在 \(range(N_i)\) 上迭代 j ,累积地将 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,则对所有轴进行缩减.如果这是一个整数元组,则对多个轴进行缩减,而不是像之前那样对单个轴或所有轴进行缩减.

对于那些既不是交换的也不是结合的操作,在多个轴上进行归约是没有明确定义的.ufuncs 目前在这种情况下不会引发异常,但未来可能会这样做.

dtype数据类型代码,可选

用于执行操作的数据类型.默认为 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 版本加入.

where布尔值的类数组对象,可选

一个布尔数组,它被广播以匹配 array 的维度,并选择要包含在归约中的元素.请注意,对于像 minimum 这样没有定义标识的通用函数,还必须传入 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

允许在通常会失败的空数组上进行缩减操作,例如在没有标识的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
On this page