# `statistics` --- 数学统计函数

3.4 新版功能.

源代码: Lib/statistics.py

该模块提供了用于计算数字 (`Real`-valued) 数据的数理统计量的函数。

此模块并不是诸如 NumPy ， SciPy 等第三方库或者诸如 Minitab ， SAS ， Matlab 等针对专业统计学家的专有全功能统计软件包的竟品。此模块针对图形和科学计算器的水平。

除非明确注释，这些函数支持 `int` ， `float` ， `Decimal` 和 `Fraction` 。当前不支持同其他类型（是否在数字塔中）的行为。混合类型的集合也是未定义的，并且依赖于实现。如果你输入的数据由混合类型组成，你应该能够使用 `map()` 来确保一个一致的结果，比如： `map(float, input_data)` 。

## 中心位置的平均值和度量

这些函数计算一个整体或样本的平均值或者特定值

`mean()` | 数据的算术平均数（“平均数”）。
`fmean()` | 快速的，浮点算数平均数。
`geometric_mean()` | 数据的几何平均数
`harmonic_mean()` | 数据的调和均值
`median()` | 数据的中位数（中间值）
`median_low()` | 数据的低中位数
`median_high()` | 数据的高中位数
`median_grouped()` | 分组数据的中位数，即第50个百分点。
`mode()` | 离散的或标称的数据的单模（最常见的值）。
`multimode()` | 离散的或标称的数据的模式列表（最常见的值）。
`quantiles()` | 将数据以相等的概率分为多个间隔。

## 传播措施

这些函数计算多少总体或者样本偏离典型值或平均值的度量。

`pstdev()` | 数据的总体标准差
`pvariance()` | 数据的总体方差
`stdev()` | 数据的样本标准差
`variance()` | 数据的样本方差

## 函数细节

注释：这些函数不需要对提供给它们的数据进行排序。但是，为了方便阅读，大多数例子展示的是已排序的序列。

`statistics.``mean`(data)

  返回 data 的样本算术平均数，形式为序列或迭代器。

  算术平均数是数据之和与数据点个数的商。通常称作“平均数”，尽管它指示诸多数学平均数之一。它是数据的中心位置的度量。

  若 data 为空，将会引发 `StatisticsError`。

  一些用法示例：

      >>> mean([1, 2, 3, 4, 4])
      2.8
      >>> mean([-1.0, 2.5, 3.25, 5.75])
      2.625

      >>> from fractions import Fraction as F
      >>> mean([F(3, 7), F(1, 21), F(5, 3), F(1, 3)])
      Fraction(13, 21)

      >>> from decimal import Decimal as D
      >>> mean([D("0.5"), D("0.75"), D("0.625"), D("0.375")])
      Decimal('0.5625')

  注解

  均值非常受异常值的影响并且这不是中心位置的可靠估计：均值不一定是数据点的典型示例。如需要更可靠的的估计，请参考 `median()` 和 `mode()` 。

  样本均值给出了一个无偏向的真实总体均值的估计，因此当平均抽取所有可能的样本， `mean(sample)` 收敛于整个总体的真实均值。如果 data 代表整个总体而不是样本，那么 `mean(data)` 等同于计算真实整体均值 μ 。

`statistics.``fmean`(data)

  将浮点数转换成 data 并且计算算术平均数。

  此函数的运行速度比 `mean()` 函数快并且它总是返回一个 `float`。 data 可以为序列或迭代器。 如果输入数据集为空，则会引发 `StatisticsError`。

      >>> fmean([3.5, 4.0, 5.25])
      4.25

  3.8 新版功能.

`statistics.``geometric_mean`(data)

  将浮点数转换成 data 并且计算几何平均数。

  几何平均值使用值的乘积表示 数据 的中心趋势或典型值（与使用它们的总和的算术平均值相反）。

  如果输入数据集为空、包含零或包含负值则将引发 `StatisticsError`。 data 可以是序列或可迭代对象。

  无需做出特殊努力即可获得准确的结果。（但是，将来或许会修改。）

      >>> round(geometric_mean([54, 24, 36]), 1)
      36.0

  3.8 新版功能.

`statistics.``harmonic_mean`(data)

  返回 data 调和均值，该参数可以是序列或包含实数值的可迭代对象。

  调和均值,也叫次相反均值，所有数据的倒数的算术平均数 `mean()` 的倒数。比如说，数据 a ， b ， c 的调和均值等于 `3/(1/a + 1/b + 1/c)` 。如果其中一个值为零，结果为零。

  调和均值是一种均值类型，是数据中心位置的度量。它通常适合于求比率和比例的平均值，比如速率。

  假设一辆车在 40 km/hr 的速度下行驶了 10 km ，然后又以 60 km/hr 的速度行驶了 10 km 。车辆的平均速率是多少？

      >>> harmonic_mean([40, 60])
      48.0

  假设一名投资者在三家公司各购买了等价值的股票，以 2.5， 3 ， 10 的 P/E (价格/收益) 率。投资者投资组合的平均市盈率是多少？

      >>> harmonic_mean([2.5, 3, 10])  # For an equal investment portfolio.
      3.6

  如果 data 为空或者 任何一个元素的值小于零，会引发 `StatisticsError` 。

  当前算法在输入中遇到零时会提前退出。这意味着不会测试后续输入的有效性。（此行为将来可能会更改。）

  3.6 新版功能.

`statistics.``median`(data)

  使用普通的“取中间两数平均值”方法返回数值数据的中位数（中间值）。 如果 data 为空，则将引发 `StatisticsError`。 data 可以是序列或可迭代对象。

  中位数是衡量中间位置的可靠方式，并且较少受到极端值的影响。 当数据点的总数为奇数时，将返回中间数据点：

      >>> median([1, 3, 5])
      3

  当数据点的总数为偶数时，中位数将通过对两个中间值求平均进行插值得出：

      >>> median([1, 3, 5, 7])
      4.0

  这适用于当你的数据是离散的，并且你不介意中位数不是实际数据点的情况。

  如果数据是有序的（支持排序操作）但不是数字（不支持加法），请考虑改用 `median_low()` 或 `median_high()`。

`statistics.``median_low`(data)

  返回数值数据的低中位数。 如果 data 为空则将引发 `StatisticsError`。 data 可以是序列或可迭代对象。

  低中位数一定是数据集的成员。 当数据点总数为奇数时，将返回中间值。 当其为偶数时，将返回两个中间值中较小的那个。

      >>> median_low([1, 3, 5])
      3
      >>> median_low([1, 3, 5, 7])
      3

  当你的数据是离散的，并且你希望中位数是一个实际数据点而非插值结果时可以使用低中位数。

`statistics.``median_high`(data)

  返回数据的高中位数。 如果 data 为空则将引发 `StatisticsError`。 data 可以是序列或可迭代对象。

  高中位数一定是数据集的成员。 当数据点总数为奇数时，将返回中间值。 当其为偶数时，将返回两个中间值中较大的那个。

      >>> median_high([1, 3, 5])
      3
      >>> median_high([1, 3, 5, 7])
      5

  当你的数据是离散的，并且你希望中位数是一个实际数据点而非插值结果时可以使用高中位数。

`statistics.``median_grouped`(data, interval=1)

  返回分组的连续数据的中位数，根据第 50 个百分点的位置使用插值来计算。 如果 data 为空则将引发 `StatisticsError`。 data 可以是序列或可迭代对象。

      >>> median_grouped([52, 52, 53, 54])
      52.5

  在下面的示例中，数据已经过舍入，这样每个值都代表数据分类的中间点，例如 1 是 0.5--1.5 分类的中间点，2 是 1.5--2.5 分类的中间点，3 是 2.5--3.5 的中间点等待。 根据给定的数据，中间值应落在 3.5--4.5 分类之内，并可使用插值法来进行估算：

      >>> median_grouped([1, 2, 2, 3, 4, 4, 4, 4, 4, 5])
      3.7

  可选参数 interval 表示分类间隔，默认值为 1。 改变分类间隔自然会改变插件结果：

      >>> median_grouped([1, 3, 3, 5, 7], interval=1)
      3.25
      >>> median_grouped([1, 3, 3, 5, 7], interval=2)
      3.5

  此函数不会检查数据点之间是否至少相隔 interval 的距离。

  CPython implementation detail: 在某些情况下，`median_grouped()` 可以会将数据点强制转换为浮点数。 此行为在未来有可能会发生改变。

  参见

  - "Statistics for the Behavioral Sciences", Frederick J Gravetter and Larry B Wallnau (8th Edition).

  - Gnome Gnumeric 电子表格中的 SSMEDIAN 函数，包括 这篇讨论。

`statistics.``mode`(data)

  根据离散或标称的 data 返回单个最觉的数据点。 此模式（如果存在）是最典型的值，并可用来度量中心的位置。

  如果存在具有相同频率的多个模式，则返回在 data 中遇到的第一个。 如果想要其中最小或最大的一个，请使用 `min(multimode(data))` 或 `max(multimode(data))`。 如果输入的 data 为空，则会引发 `StatisticsError`。

  `mode` 将假定是离散数据并返回一个单一的值。 这是通常的学校教学中标准的处理方式：

      >>> mode([1, 1, 2, 3, 3, 3, 3, 4])
      3

  此模式的独特之处在于它是这个包中唯一还可应用于标称（非数字）数据的统计信息：

      >>> mode(["red", "blue", "blue", "red", "green", "red", "red"])
      'red'

  在 3.8 版更改: 现在会通过返回所遇到的第一个模式来处理多模数据集。 之前它会在遇到超过一个的模式时引发 `StatisticsError`。

`statistics.``multimode`(data)

  返回最频繁出现的值的列表，并按它们在 data 中首次出现的位置排序。 如果存在多种模式则将返回一个以上的模式，或者如果 data 为空则将返回空列表：

      >>> multimode('aabbbbccddddeeffffgg')
      ['b', 'd', 'f']
      >>> multimode('')
      []

  3.8 新版功能.

`statistics.``pstdev`(data, mu=None)

  返回总体标准差（总体方差的平方根）。 请参阅 `pvariance()` 了解参数和其他细节。

      >>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
      0.986893273527251

`statistics.``pvariance`(data, mu=None)

  返回非空序列或包含实数值的可迭代对象 data 的总体方差。 方差或称相对于均值的二阶距，是对数据变化幅度（延展度或分散度）的度量。 方差值较大表明数据的散布范围较大；方差值较小表明它紧密聚集于均值附近。

  如果给出了可选的第二个参数 mu，它通常是 data 的均值。 它也可以被用来计算相对于一个非均值点的二阶距。 如果该参数省略或为 `None` (默认值)，则会自动进行算术均值的计算。

  使用此函数可根据所有数值来计算方差。 要根据一个样本来估算方差，通常 `variance()` 函数是更好的选择。

  如果 data 为空则会引发 `StatisticsError`。

  示例：

      >>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25]
      >>> pvariance(data)
      1.25

  如果你已经计算过数据的平均值，你可以将其作为可选的第二个参数 mu 传入以避免重复计算：

      >>> mu = mean(data)
      >>> pvariance(data, mu)
      1.25

  同样也支持使用 Decimal 和 Fraction 值：

      >>> from decimal import Decimal as D
      >>> pvariance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
      Decimal('24.815')

      >>> from fractions import Fraction as F
      >>> pvariance([F(1, 4), F(5, 4), F(1, 2)])
      Fraction(13, 72)

  注解

  当调用时附带完整的总体数据时，这将给出总体方差 σ²。 而当调用时只附带一个样本时，这将给出偏置样本方差 s²，也被称为带有 N 个自由度的方差。

  如果你通过某种方式知道了真实的总体平均值 μ，则可以使用此函数来计算一个样本的方差，并将已知的总体平均值作为第二个参数。 假设数据点是总体的一个随机样本，则结果将为总体方差的无偏估计值。

`statistics.``stdev`(data, xbar=None)

  返回样本标准差（样本方差的平方根）。 请参阅 `variance()` 了解参数和其他细节。

      >>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
      1.0810874155219827

`statistics.``variance`(data, xbar=None)

  返回包含至少两个实数值的可迭代对象 data 的样本方差。 方差或称相对于均值的二阶矩，是对数据变化幅度（延展度或分散度）的度量。 方差值较大表明数据的散布范围较大；方差值较小表明它紧密聚集于均值附近。

  如果给出了可选的第二个参数 xbar，它应当是 data 的均值。 如果该参数省略或为 `None` (默认值)，则会自动进行均值的计算。

  当你的数据是总体数据的样本时请使用此函数。 要根据整个总体数据来计算方差，请参见 `pvariance()`。

  如果 data 包含的值少于两个则会引发 `StatisticsError`。

  示例：

      >>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
      >>> variance(data)
      1.3720238095238095

  如果你已经计算过数据的平均值，你可以将其作为可选的第二个参数 xbar 传入以避免重复计算：

      >>> m = mean(data)
      >>> variance(data, m)
      1.3720238095238095

  此函数不会试图检查你所传入的 xbar 是否为真实的平均值。 使用任意值作为 xbar 可能导致无效或不可能的结果。

  同样也支持使用 Decimal 和 Fraction 值：

      >>> from decimal import Decimal as D
      >>> variance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
      Decimal('31.01875')

      >>> from fractions import Fraction as F
      >>> variance([F(1, 6), F(1, 2), F(5, 3)])
      Fraction(67, 108)

  注解

  这是附带贝塞尔校正的样本方差 s²，也称为具有 N-1 自由度的方差。 假设数据点具有代表性（即为独立且均匀的分布），则结果应当是对总体方差的无偏估计。

  如果你通过某种方式知道了真实的总体平均值 μ 则应当调用 `pvariance()` 函数并将该值作为 mu 形参传入以得到一个样本的方差。

`statistics.``quantiles`(data, *, n=4, method='exclusive')

  将 data 分隔为具有相等概率的 n 个连续区间。 返回分隔这些区间的 `n - 1` 个分隔点的列表。

  将 n 设为 4 以使用四分位（默认值）。 将 n 设为 10 以使用十分位。 将 n 设为 100 以使用百分位，即给出 99 个分隔点来将 data 分隔为 100 个大小相等的组。 如果 n 小于 1 则将引发 `StatisticsError`。

  data 可以是包含样本数据的任意可迭代对象。 为了获得有意义的结果，data 中数据点的数量应当大于 n。 如果数据点的数量小于两个则将引发 `StatisticsError`。

  分隔点是通过对两个最接近的数据点进行线性插值得到的。 例如，如果一个分隔点落在两个样本值 `100` 和 `112` 之间距离三分之一的位置，则分隔点的取值将为 `104`。

  method 用于计算分位值，它会由于 data 是包含还是排除总体的最低和最高可能值而有所不同。

  默认 method 是 “唯一的” 并且被用于在总体中数据采样这样可以有比样本中找到的更多的极端值。落在 m 个排序数据点的第 i-th 个以下的总体部分被计算为 `i / (m + 1)` 。给定九个样本值，方法排序它们并且分配一下的百分位： 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90% 。

  将 method 设为 "inclusive" 可用于描述总体数据或已明确知道包含有总体数据中最极端值的样本。 data 中的最小值会被作为第 0 个百分位而最大值会被作为第 100 个百分位。 总体数据里处于 m 个已排序数据点中 第 i 个 以下的部分会以 `(i - 1) / (m - 1)` 来计算。 给定 11 个样本值，该方法会对它们进行排序并赋予以下百分位: 0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%, 100%。

      # Decile cut points for empirically sampled data
      >>> data = [105, 129, 87, 86, 111, 111, 89, 81, 108, 92, 110,
      ...         100, 75, 105, 103, 109, 76, 119, 99, 91, 103, 129,
      ...         106, 101, 84, 111, 74, 87, 86, 103, 103, 106, 86,
      ...         111, 75, 87, 102, 121, 111, 88, 89, 101, 106, 95,
      ...         103, 107, 101, 81, 109, 104]
      >>> [round(q, 1) for q in quantiles(data, n=10)]
      [81.0, 86.2, 89.0, 99.4, 102.5, 103.6, 106.0, 109.8, 111.0]

  3.8 新版功能.

## 异常

只定义了一个异常：

exception `statistics.``StatisticsError`

  `ValueError` 的子类，表示统计相关的异常。

## `NormalDist` 对象

`NormalDist` 工具可用于创建和操纵 随机变量 的正态分布。 这个类将数据度量值的平均值和标准差作为单一实体来处理。

正态分布的概念来自于 中央极限定理 并且在统计学中有广泛的应用。

class `statistics.``NormalDist`(mu=0.0, sigma=1.0)

  返回一个新的 NormalDist 对象，其中 mu 代表 算术平均值 而 sigma 代表 标准差。

  若 sigma 为负数，将会引发 `StatisticsError`。

  `mean`

    一个只读特征属性，表示特定正态分布的 算术平均值。

  `median`

    一个只读特征属性，表示特定正态分布的 中位数。

  `mode`

    一个只读特征属性，表示特定正态分布的 模式。

  `stdev`

    一个只读特征属性，表示特定正态分布的 标准差。

  `variance`

    一个只读特征属性，表示特定正态分布的 方差。 等于标准差的平方。

  classmethod `from_samples`(data)

    传入使用 `fmean()` 和 `stdev()` 基于 data 估算出的 mu 和 sigma 形参创建一个正态分布实例。

    data 可以是任何 iterable 并且应当包含能被转换为 `float` 类型的值。 如果 data 不包含至少两个元素，则会引发 `StatisticsError`，因为估算中心值至少需要一个点而估算分散度至少需要两个点。

  `samples`(n, *, seed=None)

    对于给定的平均值和标准差生成 n 个随机样本。 返回一个由 `float` 值组成的 `list`。

    当给定 seed 时，创建一个新的底层随机数生成器实例。 这适用于创建可重现的结果，即使对于多线程上下文也有效。

  `pdf`(x)

    使用 概率密度函数 (pdf)，计算一个随机变量 X 趋向于给定值 x 的相对可能性。 在数学意义上，它是当 dx 趋向于零时比率 `P(x <= X < x+dx) / dx` 的极限。

    相对可能性的计算方法是用一个狭窄区间内某个样本出现的概率除以区间的宽度（因此使用“密度”一词）。 由于可能性是相对于其他点的，它的值可以大于 1.0。

  `cdf`(x)

    使用 累积分布函数 (cdf)，计算一个随机变量 X 小于等于 x 的概率。 在数学上，它表示为 `P(X <= x)`。

  `inv_cdf`(p)

    计算反向累积分布函数，也称为 分位数函数 或 百分点 函数。 在数学上，它表示为 `x : P(X <= x) = p`。

    找出随机变量 X 的值 x 使得该变量小于等于该值的概率等于给定的概率 p。

  `overlap`(other)

    测量两个正态概率分布之间的一致性。 返回介于 0.0 和 1.0 之间的值，给出 两个概率密度函数的重叠区域。

  `quantiles`(n=4)

    将指定正态分布划分为 n 个相等概率的连续分隔区。 返回这些分隔区对应的 (n - 1) 个分隔点的列表。

    将 n 设为 4 以使用四分位（默认值）。 将 n 设为 10 以使用十分位。将 n 设为 100 以使用百分位，即给出 99 个分隔点来将正态分布分隔为 100 个大小相等的组。

  `NormalDist` 的实例支持加上、减去、乘以或除以一个常量。 这些运算被用于转换和缩放。 例如：

      >>> temperature_february = NormalDist(5, 2.5)             # Celsius
      >>> temperature_february * (9/5) + 32                     # Fahrenheit
      NormalDist(mu=41.0, sigma=4.5)

  不允许一个常量除以 `NormalDist` 的实例，因为结果将不是正态分布。

  由于正态分布是由独立变量的累加效应产生的，因此允许表示为 `NormalDist` 实例的 两组独立正态分布的随机变量相加和相减。 例如：

      >>> birth_weights = NormalDist.from_samples([2.5, 3.1, 2.1, 2.4, 2.7, 3.5])
      >>> drug_effects = NormalDist(0.4, 0.15)
      >>> combined = birth_weights + drug_effects
      >>> round(combined.mean, 1)
      3.1
      >>> round(combined.stdev, 1)
      0.5

  3.8 新版功能.

### `NormalDist` 示例和用法

`NormalDist` 适合用来解决经典概率问题。

举例来说，如果 SAT 考试的历史数据 显示分数呈平均值为 1060 的正态分布且且标准差为 192 的正态分布，则可以确定考试分数处于 1100 和 1200 之间的学生的百分比舍入到最接近的整数应为：

    >>> sat = NormalDist(1060, 195)
    >>> fraction = sat.cdf(1200 + 0.5) - sat.cdf(1100 - 0.5)
    >>> round(fraction * 100.0, 1)
    18.4

求 SAT 分数的 四分位 和 十分位：

    >>> list(map(round, sat.quantiles()))
    [928, 1060, 1192]
    >>> list(map(round, sat.quantiles(n=10)))
    [810, 896, 958, 1011, 1060, 1109, 1162, 1224, 1310]

为了估算一个不易解析的模型分布，`NormalDist` 可以生成用于 蒙特卡洛模拟 的输入样本：

    >>> def model(x, y, z):
    ...     return (3*x + 7*x*y - 5*y) / (11 * z)
    ...
    >>> n = 100_000
    >>> X = NormalDist(10, 2.5).samples(n, seed=3652260728)
    >>> Y = NormalDist(15, 1.75).samples(n, seed=4582495471)
    >>> Z = NormalDist(50, 1.25).samples(n, seed=6582483453)
    >>> quantiles(map(model, X, Y, Z))
    [1.4591308524824727, 1.8035946855390597, 2.175091447274739]

在机器学习问题中也经常会出现正态分布。

Wikipedia 上有一个 朴素贝叶斯分类器的好例子。 挑战的问题是根据对多个正态分布的特征测量值包括身高、体重和足部尺码来预测一个人的性别。

我们得到了由八个人的测量值组成的训练数据集。 假定这些测量值是正态分布的，因此我们用 `NormalDist` 来总结数据：

    >>> height_male = NormalDist.from_samples([6, 5.92, 5.58, 5.92])
    >>> height_female = NormalDist.from_samples([5, 5.5, 5.42, 5.75])
    >>> weight_male = NormalDist.from_samples([180, 190, 170, 165])
    >>> weight_female = NormalDist.from_samples([100, 150, 130, 150])
    >>> foot_size_male = NormalDist.from_samples([12, 11, 12, 10])
    >>> foot_size_female = NormalDist.from_samples([6, 8, 7, 9])

接下来，我们遇到一个特征测量值已知但性别未知的新人：

    >>> ht = 6.0        # height
    >>> wt = 130        # weight
    >>> fs = 8          # foot size

从是男是女各 50% 的 先验概率 出发，我们通过将该先验概率乘以给定性别的特征度量值的可能性累积值来计算后验概率：

    >>> prior_male = 0.5
    >>> prior_female = 0.5
    >>> posterior_male = (prior_male * height_male.pdf(ht) *
    ...                   weight_male.pdf(wt) * foot_size_male.pdf(fs))

    >>> posterior_female = (prior_female * height_female.pdf(ht) *
    ...                     weight_female.pdf(wt) * foot_size_female.pdf(fs))

最终预测值应为最大后验概率值。 这种算法被称为 maximum a posteriori 或 MAP：

    >>> 'male' if posterior_male > posterior_female else 'female'
    'female'