Class IntMean
- java.lang.Object
-
- org.apache.commons.statistics.descriptive.IntMean
-
- All Implemented Interfaces:
DoubleSupplier,IntConsumer,IntSupplier,LongSupplier,IntStatistic,StatisticAccumulator<IntMean>,StatisticResult
public final class IntMean extends Object implements IntStatistic, StatisticAccumulator<IntMean>
Computes the arithmetic mean of the available values. Uses the following definition of the sample mean:\[ \frac{1}{n} \sum_{i=1}^n x_i \]
where \( n \) is the number of samples.
- The result is
NaNif no values are added.
This class uses an exact integer sum to compute the mean. 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
acceptorcombinemethod, it must be synchronized externally.However, it is safe to use
acceptandcombineasaccumulatorandcombinerfunctions ofCollectoron a parallel stream, because the parallel implementation ofStream.collect()provides the necessary partitioning, isolation, and merging of results for safe and efficient parallel execution.- Since:
- 1.1
- See Also:
- Mean (Wikipedia)
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(int value)Updates the state of the statistic to reflect the addition ofvalue.IntMeancombine(IntMean other)Combines the state of theotherstatistic into this one.static IntMeancreate()Creates an instance.doublegetAsDouble()Gets the mean of all input values.static IntMeanof(int... values)Returns an instance populated using the inputvalues.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.function.IntConsumer
andThen
-
Methods inherited from interface org.apache.commons.statistics.descriptive.StatisticResult
getAsBigInteger, getAsInt, getAsLong
-
-
-
-
Method Detail
-
create
public static IntMean create()
Creates an instance.The initial result is
NaN.- Returns:
IntMeaninstance.
-
of
public static IntMean of(int... values)
Returns an instance populated using the inputvalues.- Parameters:
values- Values.- Returns:
IntMeaninstance.
-
accept
public void accept(int value)
Updates the state of the statistic to reflect the addition ofvalue.- Specified by:
acceptin interfaceIntConsumer- Parameters:
value- Value.
-
getAsDouble
public double getAsDouble()
Gets the mean of all input values.When no values have been added, the result is
NaN.- Specified by:
getAsDoublein interfaceDoubleSupplier- Returns:
- mean of all values.
-
combine
public IntMean combine(IntMean other)
Description copied from interface:StatisticAccumulatorCombines the state of theotherstatistic into this one.- Specified by:
combinein interfaceStatisticAccumulator<IntMean>- Parameters:
other- Another statistic to be combined.- Returns:
thisinstance after combiningother.
-
-