# `statistics` --- 数理統計関数

バージョン 3.4 で追加.

ソースコード: Lib/statistics.py

このモジュールは、数値 (`Real` 型) データを数学的に統計計算するための関数を提供します。

The module is not intended to be a competitor to third-party libraries such as NumPy, SciPy, or proprietary full-featured statistics packages aimed at professional statisticians such as Minitab, SAS and Matlab. It is aimed at the level of graphing and scientific calculators.

特に明記しない限り、これらの関数は `int`, `float`, `Decimal` そして `Fraction` をサポートします。他の型 (算術型及びそれ以外) は現在サポートされていません。型が混ざったコレクションも未定義で実装依存です。入力データが複数の型からなる場合、`map()` を使用すると正しい結果が得られるでしょう。 例: `map(float, input_data)`。

## 平均及び中心位置の測度

これらの関数は母集団または標本の平均値や標準値を計算します。

`mean()` | データの算術平均。
`fmean()` | Fast, floating point arithmetic mean.
`geometric_mean()` | データの幾何平均。
`harmonic_mean()` | データの調和平均。
`median()` | データの中央値。
`median_low()` | データの low median。
`median_high()` | データの high median。
`median_grouped()` | grouped data の中央値、すなわち50パーセンタイル。
`mode()` | 離散/名義尺度データの最頻値 (single mode) 。
`multimode()` | List of modes (most common values) of discrete or nomimal data.
`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 を float に変換し、算術平均を計算します。

  This runs faster than the `mean()` function and it always returns a `float`. The data may be a sequence or iterable. If the input dataset is empty, raises a `StatisticsError`.

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

  バージョン 3.8 で追加.

`statistics.``geometric_mean`(data)

  Convert data to floats and compute the geometric mean.

  The geometric mean indicates the central tendency or typical value of the data using the product of the values (as opposed to the arithmetic mean which uses their sum).

  Raises a `StatisticsError` if the input dataset is empty, if it contains a zero, or if it contains a negative value. The data may be a sequence or iterable.

  No special efforts are made to achieve exact results. (However, this may change in the future.)

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

  バージョン 3.8 で追加.

`statistics.``harmonic_mean`(data)

  実数値のシーケンス型またはイテラブルの data の調和平均を返します。

  調和平均（harmonic mean, subcontrary mean）は、データの逆数の算術平均の逆数です。例えば、3つの値 a, b, c の調和平均は``3/(1/a + 1/b + 1/c)`` になります。いずれかの値が0の場合、結果は0になります。

  調和平均は平均の一種で、データの中心位置の測度です。速度のような率(rates)や比(ratios)を平均するときにしばしば適切です。

  Suppose a car travels 10 km at 40 km/hr, then another 10 km at 60 km/hr. What is the average speed?

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

  投資家がP / E（価格/収益）の比率が2.5,3,10という3つの会社のそれぞれに等しい価値の株式を購入したとします。投資家のポートフォリオの平均P / Eの比率はいくつでしょうか？

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

  もし data が空の場合、またはいずれの要素が0より小さい場合、例外 `StatisticsError` が送出されます。

  The current algorithm has an early-out when it encounters a zero in the input. This means that the subsequent inputs are not tested for validity. (This behavior may change in the future.)

  バージョン 3.6 で追加.

`statistics.``median`(data)

  一般的な「中央2つの平均をとる」方法を使用して、数値データの中央値（中間値）を返します。もし data が空の場合、例外 `StatisticsError` が送出されます。data はシーケンス型またはイテラブルにもなれます。

  中央値は外れ値の影響を受けにくいため、中心位置のロバストな測度です。データ数が奇数の場合は中央の値を返します:

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

  データ数が偶数の場合は、中央値は中央に最も近い2値の算術平均で補間されます:

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

  データが離散的で、中央値がデータ点にない値でも構わない場合に適しています。

  もしあなたのデータが（注文操作をサポートする）序数で、（追加操作をサポートしない）数値でないならば、代わりに `median_low()` または `median_high()` の使用を検討してください。

`statistics.``median_low`(data)

  数値データの小さい方の中央値(low median)を返します。もし data が空の場合、:exc:`StatisticsError`が送出されます。data はシーケンス型またはイテラブルにもなれます。

  low median は必ずデータに含まれています。データ数が奇数の場合は中央の値を返し、偶数の場合は中央の2値の小さい方を返します。

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

  データが離散的で、中央値が補間値よりもデータ点にある値の方が良い場合に用いてください。

`statistics.``median_high`(data)

  データの大きい方の中央値(high median)を返します。もし data が空の場合、`StatisticsError` が送出されます。 data はシーケンス型やイテラブルにもなれます。

  high median は必ずデータに含まれています。データ数が奇数の場合は中央の値を返し、偶数の場合は中央の2値の大きい方を返します。

      >>> 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).

  - The SSMEDIAN function in the Gnome Gnumeric spreadsheet, including this discussion.

`statistics.``mode`(data)

  Return the single most common data point from discrete or nominal data. The mode (when it exists) is the most typical value and serves as a measure of central location.

  If there are multiple modes with the same frequency, returns the first one encountered in the data. If the smallest or largest of those is desired instead, use `min(multimode(data))` or `max(multimode(data))`. If the input data is empty, `StatisticsError` is raised.

  `mode` は離散データであることを想定していて、1つの値を返します。これは学校で教わるような最頻値の標準的な取扱いです:

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

  The mode is unique in that it is the only statistic in this package that also applies to nominal (non-numeric) data:

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

  バージョン 3.8 で変更: Now handles multimodal datasets by returning the first mode encountered. Formerly, it raised `StatisticsError` when more than one mode was found.

`statistics.``multimode`(data)

  Return a list of the most frequently occurring values in the order they were first encountered in the data. Will return more than one result if there are multiple modes or an empty list if the data is empty:

      >>> 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 の母分散を返します。data は実数の空でないシーケンスまたはイテラブルです。分散、すなわち2次の中心化モーメントはデータの散らばり具合の測度です。分散が大きいデータはばらつきが大きく、分散が小さいデータは平均値のまわりに固まっています。

  If the optional second argument mu is given, it is typically the mean of the data. It can also be used to compute the second moment around a point that is not the mean. If it is missing or `None` (the default), the arithmetic mean is automatically calculated.

  母集団全体から分散を計算する場合に用いてください。標本から分散を推定する場合は `variance()` を使いましょう。

  data が空の場合 `StatisticsError` を送出します。

  例:

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

  既にデータの平均値を計算している場合、それを第2引数 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)

  注釈

  母集団全体で呼んだ場合は母分散 σ² を返します。代わりに標本で呼んだ場合は biased variance s²、すなわち自由度 N の分散を返します。

  If you somehow know the true population mean μ, you may use this function to calculate the variance of a sample, giving the known population mean as the second argument. Provided the data points are a random sample of the population, the result will be an unbiased estimate of the population variance.

`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 の標本分散を返します。data は少なくとも2つの実数の iterable です。分散、すなわち2次の中心化モーメントはデータの散らばり具合の測度です。分散が大きいデータはばらつきが大きく、分散が小さいデータは平均値のまわりに固まっています。

  第2引数 xbar に値を渡す場合は data の平均値でなくてはなりません。xbar が与えられない場合や `None` の場合 (デフォルト)、平均値は自動的に計算されます。

  データが母集団の標本であるときに用いてください。母集団全体から分散を計算するには `pvariance()` を参照してください。

  data の値が2より少ない場合 `StatisticsError` を送出します。

  例:

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

  既にデータの平均値を計算している場合、それを第2引数 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)

  注釈

  Bessel 補正済みの標本分散 s²、すなわち自由度 N-1 の分散です。与えられたデータ点が代表的 (たとえば独立で均等に分布) な場合、戻り値は母分散の不偏推定量になります。

  何らかの方法で真の母平均 μ を知っている場合、それを `pvariance()` の引数 mu に渡して標本の分散を計算することが出来ます。

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

  Divide data into n continuous intervals with equal probability. Returns a list of `n - 1` cut points separating the intervals.

  Set n to 4 for quartiles (the default). Set n to 10 for deciles. Set n to 100 for percentiles which gives the 99 cuts points that separate data into 100 equal sized groups. Raises `StatisticsError` if n is not least 1.

  The data can be any iterable containing sample data. For meaningful results, the number of data points in data should be larger than n. Raises `StatisticsError` if there are not at least two data points.

  The cut points are linearly interpolated from the two nearest data points. For example, if a cut point falls one-third of the distance between two sample values, `100` and `112`, the cut-point will evaluate to `104`.

  The method for computing quantiles can be varied depending on whether the data includes or excludes the lowest and highest possible values from the population.

  The default method is "exclusive" and is used for data sampled from a population that can have more extreme values than found in the samples. The portion of the population falling below the i-th of m sorted data points is computed as `i / (m + 1)`. Given nine sample values, the method sorts them and assigns the following percentiles: 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%.

  Setting the method to "inclusive" is used for describing population data or for samples that are known to include the most extreme values from the population. The minimum value in data is treated as the 0th percentile and the maximum value is treated as the 100th percentile. The portion of the population falling below the i-th of m sorted data points is computed as `(i - 1) / (m - 1)`. Given 11 sample values, the method sorts them and assigns the following percentiles: 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 で追加.

## 例外

例外が1つ定義されています:

exception `statistics.``StatisticsError`

  統計関係の例外。`ValueError` の派生クラス。

## `NormalDist` オブジェクト

`NormalDist` is a tool for creating and manipulating normal distributions of a random variable. It is a class that treats the mean and standard deviation of data measurements as a single entity.

Normal distributions arise from the Central Limit Theorem and have a wide range of applications in statistics.

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

  Returns a new NormalDist object where mu represents the arithmetic mean and sigma represents the standard deviation.

  sigma がマイナスの場合 `StatisticsError` を送出します。

  `mean`

    A read-only property for the arithmetic mean of a normal distribution.

  `median`

    A read-only property for the median of a normal distribution.

  `mode`

    A read-only property for the mode of a normal distribution.

  `stdev`

    A read-only property for the standard deviation of a normal distribution.

  `variance`

    A read-only property for the variance of a normal distribution. Equal to the square of the standard deviation.

  classmethod `from_samples`(data)

    Makes a normal distribution instance with mu and sigma parameters estimated from the data using `fmean()` and `stdev()`.

    The data can be any iterable and should consist of values that can be converted to type `float`. If data does not contain at least two elements, raises `StatisticsError` because it takes at least one point to estimate a central value and at least two points to estimate dispersion.

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

    Generates n random samples for a given mean and standard deviation. Returns a `list` of `float` values.

    If seed is given, creates a new instance of the underlying random number generator. This is useful for creating reproducible results, even in a multi-threading context.

  `pdf`(x)

    Using a probability density function (pdf), compute the relative likelihood that a random variable X will be near the given value x. Mathematically, it is the limit of the ratio `P(x <= X < x+dx) / dx` as dx approaches zero.

    The relative likelihood is computed as the probability of a sample occurring in a narrow range divided by the width of the range (hence the word "density"). Since the likelihood is relative to other points, its value can be greater than 1.0.

  `cdf`(x)

    Using a cumulative distribution function (cdf), compute the probability that a random variable X will be less than or equal to x. Mathematically, it is written `P(X <= x)`.

  `inv_cdf`(p)

    Compute the inverse cumulative distribution function, also known as the quantile function or the percent-point function. Mathematically, it is written `x : P(X <= x) = p`.

    Finds the value x of the random variable X such that the probability of the variable being less than or equal to that value equals the given probability p.

  `overlap`(other)

    Measures the agreement between two normal probability distributions. Returns a value between 0.0 and 1.0 giving the overlapping area for the two probability density functions.

  `quantiles`(n=4)

    Divide the normal distribution into n continuous intervals with equal probability. Returns a list of (n - 1) cut points separating the intervals.

    Set n to 4 for quartiles (the default). Set n to 10 for deciles. Set n to 100 for percentiles which gives the 99 cuts points that separate the normal distribution into 100 equal sized groups.

  Instances of `NormalDist` support addition, subtraction, multiplication and division by a constant. These operations are used for translation and scaling. For example:

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

  Dividing a constant by an instance of `NormalDist` is not supported because the result wouldn't be normally distributed.

  Since normal distributions arise from additive effects of independent variables, it is possible to add and subtract two independent normally distributed random variables represented as instances of `NormalDist`. For example:

      >>> 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` readily solves classic probability problems.

For example, given historical data for SAT exams showing that scores are normally distributed with a mean of 1060 and a standard deviation of 195, determine the percentage of students with test scores between 1100 and 1200, after rounding to the nearest whole number:

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

Find the quartiles and deciles for the SAT scores:

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

To estimate the distribution for a model than isn't easy to solve analytically, `NormalDist` can generate input samples for a Monte Carlo simulation:

    >>> 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]

Normal distributions can be used to approximate Binomial distributions when the sample size is large and when the probability of a successful trial is near 50%.

For example, an open source conference has 750 attendees and two rooms with a 500 person capacity. There is a talk about Python and another about Ruby. In previous conferences, 65% of the attendees preferred to listen to Python talks. Assuming the population preferences haven't changed, what is the probability that the Python room will stay within its capacity limits?

    >>> n = 750             # Sample size
    >>> p = 0.65            # Preference for Python
    >>> q = 1.0 - p         # Preference for Ruby
    >>> k = 500             # Room capacity

    >>> # Approximation using the cumulative normal distribution
    >>> from math import sqrt
    >>> round(NormalDist(mu=n*p, sigma=sqrt(n*p*q)).cdf(k + 0.5), 4)
    0.8402

    >>> # Solution using the cumulative binomial distribution
    >>> from math import comb, fsum
    >>> round(fsum(comb(n, r) * p**r * q**(n-r) for r in range(k+1)), 4)
    0.8402

    >>> # Approximation using a simulation
    >>> from random import seed, choices
    >>> seed(8675309)
    >>> def trial():
    ...     return choices(('Python', 'Ruby'), (p, q), k=n).count('Python')
    >>> mean(trial() <= k for i in range(10_000))
    0.8398

Normal distributions commonly arise in machine learning problems.

Wikipedia has a nice example of a Naive Bayesian Classifier. The challenge is to predict a person's gender from measurements of normally distributed features including height, weight, and foot size.

We're given a training dataset with measurements for eight people. The measurements are assumed to be normally distributed, so we summarize the data with `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])

Next, we encounter a new person whose feature measurements are known but whose gender is unknown:

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

Starting with a 50% prior probability of being male or female, we compute the posterior as the prior times the product of likelihoods for the feature measurements given the gender:

    >>> 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))

The final prediction goes to the largest posterior. This is known as the maximum a posteriori or MAP:

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