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, 可选

权重数组可以是一维的（在这种情况下，其长度必须是 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 的掩码数组。

参考资料

[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