numpy.choose#

numpy.choose(a, choices, out=None, mode='raise')[source]#

从索引数组和一系列可选数组构造一个数组。

首先,如果感到困惑或不确定,一定要查看示例——从以下代码描述来看,这个函数的通用性比它看起来要复杂得多。

np.choose(a,c) == np.array([c[a[I]][I] for I in np.ndindex(a.shape)])

但这忽略了一些细微之处。这是一个完整的总结:

给定一个整数“索引”数组(a)和一个包含 n 个数组的序列(choices),a 和每个可选数组都根据需要首先进行广播,以形成具有共同形状的数组;称这些数组为 BaBchoices[i], i = 0,…,n-1,我们必须有 Ba.shape == Bchoices[i].shape 对于每个 i。然后,创建一个具有形状 Ba.shape 的新数组,方法如下:

  • 如果 mode='raise'(默认值),那么首先,a(以及 Ba)的每个元素必须在范围 [0, n-1] 内;现在,假设 i(在该范围内)是 Ba(j0, j1, ..., jm) 位置的值——那么新数组中相同位置的值就是 Bchoices[i] 中相同位置的值;

  • 如果 mode='wrap'a(以及 Ba)中的值可以是任何(带符号)整数;使用模算术将范围 [0, n-1] 之外的整数映射回该范围;然后如上所述构造新数组;

  • 如果 mode='clip'a(以及 Ba)中的值可以是任何(带符号)整数;负整数映射到 0;大于 n-1 的值映射到 n-1;然后如上所述构造新数组。

参数:
a整数数组

此数组必须包含 [0, n-1] 中的整数,其中 n 是选择的数量,除非 mode=wrapmode=clip,在这种情况下,任何整数都是允许的。

choices数组序列

可选数组。a 和所有选择都必须能够广播到相同的形状。如果 choices 本身是一个数组(不推荐),则其最外层维度(即对应于 choices.shape[0] 的维度)被视为定义“序列”。

out数组,可选

如果提供,结果将插入到此数组中。它应该具有合适的形状和数据类型。请注意,如果 mode='raise',则 out 始终被缓冲;使用其他模式以获得更好的性能。

mode{'raise' (默认值), 'wrap', 'clip'},可选

指定如何处理 [0, n-1] 之外的索引

  • ‘raise’:引发异常

  • ‘wrap’:值变为 value mod n

  • ‘clip’:值 < 0 映射到 0,值 > n-1 映射到 n-1

返回:
merged_array数组

合并的结果。

引发:
ValueError: 形状不匹配

如果 a 和每个可选数组都不能广播到相同的形状。

另请参阅

ndarray.choose

等效方法

numpy.take_along_axis

如果 choices 是一个数组,则更可取。

备注

为了减少误解的可能性,即使以下“滥用”在名义上得到支持,choices 也不应该被认为是一个单独的数组,即最外层的类似序列的容器应该是一个列表或元组。

示例

>>> import numpy as np
>>> choices = [[0, 1, 2, 3], [10, 11, 12, 13],
...   [20, 21, 22, 23], [30, 31, 32, 33]]
>>> np.choose([2, 3, 1, 0], choices
... # the first element of the result will be the first element of the
... # third (2+1) "array" in choices, namely, 20; the second element
... # will be the second element of the fourth (3+1) choice array, i.e.,
... # 31, etc.
... )
array([20, 31, 12,  3])
>>> np.choose([2, 4, 1, 0], choices, mode='clip') # 4 goes to 3 (4-1)
array([20, 31, 12,  3])
>>> # because there are 4 choice arrays
>>> np.choose([2, 4, 1, 0], choices, mode='wrap') # 4 goes to (4 mod 4)
array([20,  1, 12,  3])
>>> # i.e., 0

几个说明 choose 如何广播的示例

>>> a = [[1, 0, 1], [0, 1, 0], [1, 0, 1]]
>>> choices = [-10, 10]
>>> np.choose(a, choices)
array([[ 10, -10,  10],
       [-10,  10, -10],
       [ 10, -10,  10]])
>>> # With thanks to Anne Archibald
>>> a = np.array([0, 1]).reshape((2,1,1))
>>> c1 = np.array([1, 2, 3]).reshape((1,3,1))
>>> c2 = np.array([-1, -2, -3, -4, -5]).reshape((1,1,5))
>>> np.choose(a, (c1, c2)) # result is 2x3x5, res[0,:,:]=c1, res[1,:,:]=c2
array([[[ 1,  1,  1,  1,  1],
        [ 2,  2,  2,  2,  2],
        [ 3,  3,  3,  3,  3]],
       [[-1, -2, -3, -4, -5],
        [-1, -2, -3, -4, -5],
        [-1, -2, -3, -4, -5]]])