scipy.stats.mstats.

hmean#

scipy.stats.mstats.hmean(a, axis=0, dtype=None, *, weights=None, nan_policy='propagate', keepdims=False)[源代码]#

计算指定轴上的加权调和平均值。

数组 \(a_i\) 与权重 \(w_i\) 关联的加权调和平均值为

\[\frac{ \sum_{i=1}^n w_i }{ \sum_{i=1}^n \frac{w_i}{a_i} } \, ,\]

并且,使用相等的权重,它给出

\[\frac{ n }{ \sum_{i=1}^n \frac{1}{a_i} } \, .\]
参数:
aarray_like

输入数组、掩码数组或可以转换为数组的对象。

axisint 或 None,默认值:0

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

dtypedtype,可选

返回数组和累加器的类型,元素在其中求和。如果未指定 dtype,则默认为 a 的 dtype,除非 a 具有整数 dtype,其精度低于默认平台整数。在这种情况下,使用默认平台整数。

weightsarray_like,可选

权重数组可以是 1-D(在这种情况下,其长度必须是 a 沿给定 axis 的大小),也可以与 a 的形状相同。默认为 None,这为每个值赋予 1.0 的权重。

1.9 版本中新增。

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

定义如何处理输入 NaN。

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

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

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

keepdimsbool,默认值:False

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

返回:
hmeanndarray

参见上面的 dtype 参数。

另请参见

numpy.mean

算术平均值

numpy.average

加权平均值

gmean

几何平均值

注释

样本调和平均值是观测值倒数的平均值的倒数。

调和平均值是在输入数组的单个维度上计算的,默认情况下为 axis=0,如果 axis=None,则为数组中的所有值。float64 中间值和返回值用于整数输入。

仅当所有观测值均为非负数时,才定义调和平均值;否则,结果为 NaN。

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

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

CPU

GPU

NumPy

不适用

CuPy

不适用

PyTorch

JAX

⚠️ 无 JIT

⚠️ 无 JIT

Dask

⚠️ 计算图

不适用

有关更多信息,请参见 对数组 API 标准的支持

参考文献

[1]

“加权调和平均值”,维基百科https://en.wikipedia.org/wiki/Harmonic_mean#Weighted_harmonic_mean

[2]

Ferger, F., “调和平均值的性质和用途”,美国统计协会杂志,第 26 卷,第 36-40 页,1931 年

示例

>>> from scipy.stats import hmean
>>> hmean([1, 4])
1.6000000000000001
>>> hmean([1, 2, 3, 4, 5, 6, 7])
2.6997245179063363
>>> hmean([1, 4, 7], weights=[3, 1, 3])
1.9029126213592233