scipy.stats.

tmax#

scipy.stats.tmax(a, upperlimit=None, axis=0, inclusive=True, nan_policy='propagate', *, keepdims=False)[source]#

计算修剪后的最大值。

此函数计算数组沿给定轴的最大值,同时忽略大于指定上限的值。

参数:
aarray_like

值的数组。

upperlimitNone 或 float,可选

输入数组中大于给定限制的值将被忽略。当 upperlimit 为 None 时,将使用所有值。默认值为 None。

axisint 或 None,默认值:0

如果为 int,则为沿其计算统计量的输入的轴。输入的每个轴切片(例如,行)的统计量将出现在输出的相应元素中。如果为 None,则在计算统计量之前将输入展平。

inclusive{True, False}, 可选

此标志确定是否包含与上限完全相等的值。默认值为 True。

nan_policy{‘propagate’, ‘omit’, ‘raise’}

定义如何处理输入 NaN。

  • propagate: 如果在计算统计量的轴切片(例如,行)中存在 NaN,则输出的相应条目将为 NaN。

  • omit: 执行计算时将省略 NaN。 如果在计算统计量的轴切片中剩余的数据不足,则输出的相应条目将为 NaN。

  • raise: 如果存在 NaN,将引发 ValueError

keepdimsbool,默认值:False

如果将其设置为 True,则缩小的轴将作为大小为 1 的维度保留在结果中。使用此选项,结果将针对输入数组正确广播。

返回:
tmaxfloat, int 或 ndarray

修剪后的最大值。

注释

从 SciPy 1.9 开始,np.matrix 输入(不建议用于新代码)在执行计算之前会转换为 np.ndarray。 在这种情况下,输出将是标量或具有适当形状的 np.ndarray,而不是 2D np.matrix。 类似地,虽然会忽略 masked 数组的 masked 元素,但输出将是标量或 np.ndarray,而不是 mask=False 的 masked 数组。

tmax 除了 NumPy 之外,还对 Python Array API 标准兼容后端提供实验性支持。 请考虑通过设置环境变量 SCIPY_ARRAY_API=1 并提供 CuPy、PyTorch、JAX 或 Dask 数组作为数组参数来测试这些功能。 支持以下后端和设备(或其他功能)的组合。

CPU

GPU

NumPy

n/a

CuPy

n/a

PyTorch

JAX

Dask

n/a

有关更多信息,请参见 支持 array API 标准

示例

>>> import numpy as np
>>> from scipy import stats
>>> x = np.arange(20)
>>> stats.tmax(x)
19
>>> stats.tmax(x, 13)
13
>>> stats.tmax(x, 13, inclusive=False)
12