numpy.ufunc.reduce#

method

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 可以为负数,在这种情况下,它从最后一个轴计数到第一个轴.

如果为 None,则对所有轴执行归约.如果这是一个整数元组,则在多个轴上执行归约,而不是像以前那样在单个轴或所有轴上执行归约.

对于不可交换或不关联的操作,在多个轴上进行归约的定义不明确.在这种情况下,ufunc 目前不会引发异常,但将来可能会这样做.

dtype数据类型代码,可选

用于执行操作的数据类型.如果给定了 out ,则默认为 out 的数据类型,否则默认为 array 的数据类型(尽管对于某些情况,会进行向上转换以保持精度,例如整数或布尔输入的 numpy.add.reduce ).

outndarray, None, …, or tuple of ndarray and None, optional

存储结果的位置.如果未提供或为 None,则返回一个新分配的数组.如果作为关键字参数传递,则可以是省略号 ( out=... ) 以确保即使结果是 0 维的也返回一个数组(这对于对象 dtype 尤其有用),或者是一个 1 元素元组(后者是为了与 ufunc.__call__ 保持一致).

在 2.3 版本加入: 添加了对 out=... 的支持.

keepdimsbool, 可选

如果设置为 True,则被缩减的轴将保留在结果中,作为大小为 1 的维度.使用此选项,结果将正确地广播到原始 array .

initial标量,可选.

用于启动缩减的值.如果 ufunc 没有 identity 或 dtype 是 object,则默认为 None - 否则默认为 ufunc.identity.如果给定 None ,则使用缩减的第一个元素,如果缩减为空,则会引发错误.

wherebool 的类数组对象,可选

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

允许对空数组进行缩减,否则这些缩减通常会失败,即对于没有 identity 的 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
当前页面