numpy.argpartition

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

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

在 1.8.0 版本加入.

参数:

aarray_like

要排序的数组.

kth整数或整数序列

按其分区的元素索引.第k个元素将处于其最终排序位置,并且所有较小的元素将移动到它之前,所有较大的元素移动到它之后.分区中所有元素的顺序未定义.如果提供一个k-th序列,它将一次性将它们全部分区到其排序位置.

自 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 到一个数组,就像调用 partition 一样.

备注

返回的索引不保证按照值排序.此外,默认的选择算法 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]])