numpy.ptp#

numpy.ptp(a, axis=None, out=None, keepdims=<no value>)[源]#

沿轴的值范围(最大值 - 最小值)。

该函数的名称来源于“峰峰值”(peak to peak)的首字母缩略词。

警告

ptp 会保留数组的数据类型。这意味着对于 n 位有符号整数(例如 numpy.int8numpy.int16 等)的输入,返回值也将是 n 位有符号整数。在这种情况下,大于 2**(n-1)-1 的峰峰值将作为负值返回。下面显示了一个带有变通方法的示例。

参数:
a类数组

输入值。

axisNone 或 int 或 int 元组,可选

查找峰值的轴。默认情况下,展平数组。axis 可以是负数,此时它从最后一个轴计数到第一个轴。如果这是一个 int 元组,则对多个轴执行归约,而不是像以前那样对单个轴或所有轴执行归约。

out类数组

用于放置结果的替代输出数组。它必须与预期输出具有相同的形状和缓冲区长度,但如果需要,输出值的类型将被转换。

keepdimsbool,可选

如果设置为 True,则被归约的轴将作为大小为一的维度保留在结果中。使用此选项,结果将与输入数组正确广播。

如果传递默认值,则 keepdims 不会传递给 ndarray 子类的 ptp 方法,但任何非默认值都会被传递。如果子类的方法未实现 keepdims,则会引发任何异常。

返回:
ptpndarray 或标量

给定数组的范围 - 如果数组是一维的,则为 标量;否则为沿给定轴保存结果的新数组。

示例

>>> import numpy as np
>>> x = np.array([[4, 9, 2, 10],
...               [6, 9, 7, 12]])
>>> np.ptp(x, axis=1)
array([8, 6])
>>> np.ptp(x, axis=0)
array([2, 0, 5, 2])
>>> np.ptp(x)
10

此示例显示,当输入是有符号整数数组时,可能会返回负值。

>>> y = np.array([[1, 127],
...               [0, 127],
...               [-1, 127],
...               [-2, 127]], dtype=np.int8)
>>> np.ptp(y, axis=1)
array([ 126,  127, -128, -127], dtype=int8)

一个变通方法是使用 view() 方法将结果视为具有相同位宽的无符号整数。

>>> np.ptp(y, axis=1).view(np.uint8)
array([126, 127, 128, 129], dtype=uint8)