numpy.choose#

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

从索引数组和要选择的数组列表构建数组。

首先,如果感到困惑或不确定,请务必查看示例 - 在其完全通用性中,此函数比以下代码描述(ndi = numpy.lib.index_tricks)看起来要复杂。

np.choose(a,c) == np.array([c[a[I]][I] for I in ndi.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;然后,如上所述构建新数组。

参数::
aint 数组

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

choices数组序列

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

out数组,可选

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

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

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

  • ‘raise’:引发异常

  • ‘wrap’:值变为值 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]]])