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 或 ints 元組,選用

要沿其執行歸約的軸或軸。預設值 (axis = 0) 是對輸入陣列的第一個維度執行歸約。axis 可以是負數,在這種情況下,它從最後一個軸算到第一個軸。

如果這是 None,則對所有軸執行歸約。如果這是 ints 元組,則對多個軸執行歸約,而不是像之前那樣對單個軸或所有軸執行歸約。

對於非可交換或非結合律的運算,對多個軸執行歸約並未明確定義。ufuncs 目前在這種情況下不會引發例外,但未來可能會這樣做。

dtype資料類型代碼,選用

用於執行運算的資料類型。如果給定 out,則預設為 out 的資料類型,否則預設為 array 的資料類型(但會向上轉換以保留某些情況下的精確度,例如整數或布林輸入的 numpy.add.reduce)。

outndarray、None 或 ndarray 和 None 的元組,選用

結果儲存的位置。如果未提供或為 None,則會傳回新配置的陣列。為了與 ufunc.__call__ 一致,如果以關鍵字形式給定,則可以將其包裝在 1 元素元組中。

keepdimsbool,選用

如果設定為 True,則縮減的軸會以大小為 1 的維度留在結果中。使用此選項,結果將針對原始 array 正確廣播。

initial純量,選用

用於開始歸約的值。如果 ufunc 沒有單位元素或 dtype 是物件,則預設為 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