Package org.apache.commons.statistics.descriptive

Class IntVariance

java.lang.Object
org.apache.commons.statistics.descriptive.IntVariance
All Implemented Interfaces:
DoubleSupplier, IntConsumer, IntSupplier, LongSupplier, IntStatistic, StatisticAccumulator<IntVariance>, StatisticResult
public final class IntVariance extends Object implements IntStatistic, StatisticAccumulator<IntVariance>
Computes the variance of the available values. The default implementation uses the following definition of the sample variance:

\[ \tfrac{1}{n-1} \sum_{i=1}^n (x_i-\overline{x})^2 \]

where \( \overline{x} \) is the sample mean, and \( n \) is the number of samples.

  • The result is NaN if no values are added.
  • The result is zero if there is one value in the data set.

The use of the term \( n − 1 \) is called Bessel's correction. This is an unbiased estimator of the variance of a hypothetical infinite population. If the biased option is enabled the normalisation factor is changed to \( \frac{1}{n} \) for a biased estimator of the sample variance.

The implementation uses an exact integer sum to compute the scaled (by \( n \)) sum of squared deviations from the mean; this is normalised by the scaled correction factor.

\[ \frac {n \times \sum_{i=1}^n x_i^2 - (\sum_{i=1}^n x_i)^2}{n \times (n - 1)} \]

Supports up to 263 (exclusive) observations. This implementation does not check for overflow of the count.

This class is designed to work with (though does not require) streams.

This implementation is not thread safe. If multiple threads access an instance of this class concurrently, and at least one of the threads invokes the accept or combine method, it must be synchronized externally.

However, it is safe to use accept and combine as accumulator and combiner functions of Collector on a parallel stream, because the parallel implementation of Stream.collect() provides the necessary partitioning, isolation, and merging of results for safe and efficient parallel execution.

Since:
1.1
See Also:

  • Method Details

    • create

      public static IntVariance create()
      Creates an instance.

      The initial result is NaN.

      Returns:
      IntVariance instance.

    • of

      public static IntVariance of(int... values)
      Returns an instance populated using the input values.
      Parameters:
      values - Values.
      Returns:
      IntVariance instance.

    • ofRange

      public static IntVariance ofRange(int[] values, int from, int to)
      Returns an instance populated using the specified range of values.
      Parameters:
      values - Values.
      from - Inclusive start of the range.
      to - Exclusive end of the range.
      Returns:
      IntVariance instance.
      Throws:
      IndexOutOfBoundsException - if the sub-range is out of bounds
      Since:
      1.2

    • accept

      public void accept(int value)
      Updates the state of the statistic to reflect the addition of value.
      Specified by:
      accept in interface IntConsumer
      Parameters:
      value - Value.

    • getAsDouble

      public double getAsDouble()
      Gets the variance of all input values.

      When no values have been added, the result is NaN.

      Specified by:
      getAsDouble in interface DoubleSupplier
      Returns:
      variance of all values.

    • combine

      public IntVariance combine(IntVariance other)
      Description copied from interface: StatisticAccumulator
      Combines the state of the other statistic into this one.
      Specified by:
      combine in interface StatisticAccumulator<IntVariance>
      Parameters:
      other - Another statistic to be combined.
      Returns:
      this instance after combining other.

    • setBiased

      public IntVariance setBiased(boolean v)
      Sets the value of the biased flag. The default value is false.

      If false the sum of squared deviations from the sample mean is normalised by n - 1 where n is the number of samples. This is Bessel's correction for an unbiased estimator of the variance of a hypothetical infinite population.

      If true the sum of squared deviations is normalised by the number of samples n.

      Note: This option only applies when n > 1. The variance of n = 1 is always 0.

      This flag only controls the final computation of the statistic. The value of this flag will not affect compatibility between instances during a combine operation.

      Parameters:
      v - Value.
      Returns:
      this instance