Class DoubleStatistics
- java.lang.Object
-
- org.apache.commons.statistics.descriptive.DoubleStatistics
-
- All Implemented Interfaces:
DoubleConsumer
public final class DoubleStatistics extends Object implements DoubleConsumer
Statistics fordoublevalues.This class provides combinations of individual statistic implementations in the
org.apache.commons.statistics.descriptivepackage.Supports up to 263 (exclusive) observations. This implementation does not check for overflow of the count.
- Since:
- 1.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDoubleStatistics.BuilderA builder forDoubleStatistics.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(double value)Updates the state of the statistics to reflect the addition ofvalue.static DoubleStatistics.Builderbuilder(Statistic... statistics)Returns a new builder configured to create instances to compute the specifiedstatistics.DoubleStatisticscombine(DoubleStatistics other)Combines the state of theotherstatistics into this one.doublegetAsDouble(Statistic statistic)Gets the value of the specifiedstatisticas adouble.longgetCount()Return the count of values recorded.StatisticResultgetResult(Statistic statistic)Gets a supplier for the value of the specifiedstatistic.booleanisSupported(Statistic statistic)Check if the specifiedstatisticis supported.static DoubleStatisticsof(Set<Statistic> statistics, double... values)Returns a new instance configured to compute the specifiedstatisticspopulated using the inputvalues.static DoubleStatisticsof(Statistic... statistics)Returns a new instance configured to compute the specifiedstatistics.DoubleStatisticssetConfiguration(StatisticsConfiguration v)Sets the statistics configuration.-
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.DoubleConsumer
andThen
-
-
-
-
Method Detail
-
of
public static DoubleStatistics of(Statistic... statistics)
Returns a new instance configured to compute the specifiedstatistics.The statistics will be empty and so will return the default values for each computed statistic.
- Parameters:
statistics- Statistics to compute.- Returns:
- the instance
- Throws:
IllegalArgumentException- if there are nostatisticsto compute.
-
of
public static DoubleStatistics of(Set<Statistic> statistics, double... values)
Returns a new instance configured to compute the specifiedstatisticspopulated using the inputvalues.Use this method to create an instance populated with a (variable) array of
double[]data:DoubleStatistics stats = DoubleStatistics.of( EnumSet.of(Statistic.MIN, Statistic.MAX), 1, 1, 2, 3, 5, 8, 13);- Parameters:
statistics- Statistics to compute.values- Values.- Returns:
- the instance
- Throws:
IllegalArgumentException- if there are nostatisticsto compute.
-
builder
public static DoubleStatistics.Builder builder(Statistic... statistics)
Returns a new builder configured to create instances to compute the specifiedstatistics.Use this method to create an instance populated with an array of
double[]data using theDoubleStatistics.Builder.build(double...)method:double[] data = ... DoubleStatistics stats = DoubleStatistics.builder( Statistic.MIN, Statistic.MAX, Statistic.VARIANCE) .build(data);The builder can be used to create multiple instances of
DoubleStatisticsto be used in parallel, or on separate arrays ofdouble[]data. These may becombined. For example:double[][] data = ... DoubleStatistics.Builder builder = DoubleStatistics.builder( Statistic.MIN, Statistic.MAX, Statistic.VARIANCE); DoubleStatistics stats = Arrays.stream(data) .parallel() .map(builder::build) .reduce(DoubleStatistics::combine) .get();The builder can be used to create a
Collectorfor repeat use on multiple data:DoubleStatistics.Builder builder = DoubleStatistics.builder( Statistic.MIN, Statistic.MAX, Statistic.VARIANCE); Collector<double[], DoubleStatistics, DoubleStatistics> collector = Collector.of(builder::build, (s, d) -> s.combine(builder.build(d)), DoubleStatistics::combine); // Repeated double[][] data = ... DoubleStatistics stats = Arrays.stream(data).collect(collector);- Parameters:
statistics- Statistics to compute.- Returns:
- the builder
- Throws:
IllegalArgumentException- if there are nostatisticsto compute.
-
accept
public void accept(double value)
Updates the state of the statistics to reflect the addition ofvalue.- Specified by:
acceptin interfaceDoubleConsumer- Parameters:
value- Value.
-
getCount
public long getCount()
Return the count of values recorded.- Returns:
- the count of values
-
isSupported
public boolean isSupported(Statistic statistic)
Check if the specifiedstatisticis supported.Note: This method will not return
falseif the argument isnull.- Parameters:
statistic- Statistic.- Returns:
trueif supported- Throws:
NullPointerException- if thestatisticisnull- See Also:
getAsDouble(Statistic)
-
getAsDouble
public double getAsDouble(Statistic statistic)
Gets the value of the specifiedstatisticas adouble.- Parameters:
statistic- Statistic.- Returns:
- the value
- Throws:
IllegalArgumentException- if thestatisticis not supported- See Also:
isSupported(Statistic),getResult(Statistic)
-
getResult
public StatisticResult getResult(Statistic statistic)
Gets a supplier for the value of the specifiedstatistic.The returned function will supply the correct result after calls to
acceptorcombinefurther values intothisinstance.This method can be used to perform a one-time look-up of the statistic function to compute statistics as values are dynamically added.
- Parameters:
statistic- Statistic.- Returns:
- the supplier
- Throws:
IllegalArgumentException- if thestatisticis not supported- See Also:
isSupported(Statistic),getAsDouble(Statistic)
-
combine
public DoubleStatistics combine(DoubleStatistics other)
Combines the state of theotherstatistics into this one. Onlythisinstance is modified by thecombineoperation.The
otherinstance must be compatible. This istrueif theotherinstance returnstrueforisSupported(Statistic)for all values of theStatisticenum which are supported bythisinstance.Note that this operation is not symmetric. It may be possible to perform
a.combine(b)but notb.combine(a). In the event that theotherinstance is not compatible then an exception is raised before any state is modified.- Parameters:
other- Another set of statistics to be combined.- Returns:
thisinstance after combiningother.- Throws:
IllegalArgumentException- if theotheris not compatible
-
setConfiguration
public DoubleStatistics setConfiguration(StatisticsConfiguration v)
Sets the statistics configuration.These options only control the final computation of statistics. The configuration will not affect compatibility between instances during a
combineoperation.Note: These options will affect any future computation of statistics. Supplier functions that have been previously created will not be updated with the new configuration.
- Parameters:
v- Value.- Returns:
thisinstance- Throws:
NullPointerException- if the value is null- See Also:
getResult(Statistic)
-
-