numpy.argpartition#

numpy.argpartition(a, kth, axis=-1, kind='introselect', order=None)[source]#

使用 kind 关键字指定的算法,沿给定轴执行间接分区。它返回一个与 a 形状相同的索引数组,这些索引按分区顺序索引沿给定轴的数据。

版本 1.8.0 中的新增内容。

参数:
aarray_like

要排序的数组。

kthint 或 int 序列

要按其进行分区的元素索引。第 k 个元素将处于其最终排序位置,所有较小的元素将移动到其前面,所有较大的元素将移动到其后面。分区中所有元素的顺序是未定义的。如果提供一个 kth 序列,它将一次将所有这些元素分区到其排序位置。

已弃用,从版本 1.22.0 起:传递布尔值作为索引已弃用。

axisint 或 None,可选

要排序的轴。默认值为 -1(最后一个轴)。如果为 None,则使用扁平化数组。

kind{‘introselect’},可选

选择算法。默认值为 ‘introselect’

orderstr 或 str 列表,可选

a 是一个定义了字段的数组时,此参数指定首先比较哪些字段,其次比较哪些字段,等等。单个字段可以指定为字符串,并不需要指定所有字段,但未指定的字段仍将使用,按照它们在 dtype 中出现的顺序,以打破平局。

返回值:
index_arrayndarray,int

沿指定轴对 a 进行分区的索引数组。如果 a 是一个一维数组,a[index_array] 将产生一个已分区的 a。更一般地,np.take_along_axis(a, index_array, axis=axis) 将始终产生已分区的 a,无论维度如何。

参见

partition

描述了所用的分区算法。

ndarray.partition

就地分区。

argsort

完整的间接排序。

take_along_axis

index_array 从 argpartition 应用于数组,就像调用分区一样。

注意事项

返回的索引不能保证按值排序。此外,默认选择算法 introselect 是不稳定的,因此返回的索引不能保证是元素的最早/最晚出现。

argpartition 对具有 nan 值的实数/复数输入有效,请参见 partition 以了解有关增强排序顺序和不同选择算法的说明。

示例

一维数组

>>> import numpy as np
>>> x = np.array([3, 4, 2, 1])
>>> x[np.argpartition(x, 3)]
array([2, 1, 3, 4]) # may vary
>>> x[np.argpartition(x, (1, 3))]
array([1, 2, 3, 4]) # may vary
>>> x = [3, 4, 2, 1]
>>> np.array(x)[np.argpartition(x, 3)]
array([2, 1, 3, 4]) # may vary

多维数组

>>> x = np.array([[3, 4, 2], [1, 3, 1]])
>>> index_array = np.argpartition(x, kth=1, axis=-1)
>>> # below is the same as np.partition(x, kth=1)
>>> np.take_along_axis(x, index_array, axis=-1)
array([[2, 3, 4],
       [1, 1, 3]])