org.jenetics.tool.trial

Class SampleSummaryStatistics

java.lang.Object

org.jenetics.tool.trial.SampleSummaryStatistics

All Implemented Interfaces:

Consumer<Sample>

public class SampleSummaryStatistics
extends Object
implements Consumer<Sample>

A state object for collecting statistics such as count, min, max, sum, mean, variance, skewness and kurtosis. The design of this class is similar to the DoubleSummaryStatistics class.

final Stream<Sample> stream = ... final SampleSummaryStatistics statistics = stream.collect( () -> new SampleSummaryStatistics(parameterCount), SampleSummaryStatistics::accept, SampleSummaryStatistics::combine );

Implementation note: This implementation is not thread safe. However, it is safe to use toSampleStatistics(int) 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:

3.4

Version:

3.4

Author:

Franz Wilhelmstötter

Constructor Summary

Constructors

Constructor and Description
SampleSummaryStatistics(int parameterCount) Create a new statistics object with the given expected parameter count of the accepted samples.

Method Summary

Modifier and Type	Method and Description
void	accept(Sample sample)
SampleSummaryStatistics	combine(SampleSummaryStatistics other) Combine two SampleSummaryStatistics statistic objects.
ISeq<DoubleMomentStatistics>	getMoments() Return the raw DoubleMomentStatistics objects.
ISeq<org.jenetics.tool.trial.ExactQuantile>	getQuantiles() Return the quantile object.
static Collector<Sample,?,SampleSummaryStatistics>	toSampleStatistics(int parameterCount) Return a Collector which applies an double-producing mapping function to each input element, and returns moments-statistics for the resulting values.

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

andThen

Constructor Detail

SampleSummaryStatistics

public SampleSummaryStatistics(int parameterCount)

Create a new statistics object with the given expected parameter count of the accepted samples.

Parameters:

parameterCount - the parameter count or sample size, respectively

Throws:

IllegalArgumentException - if the given parameterCount is smaller then one

Method Detail

accept

public void accept(Sample sample)

Specified by:

accept in interface Consumer<Sample>

combine

public SampleSummaryStatistics combine(SampleSummaryStatistics other)

Combine two SampleSummaryStatistics statistic objects.

Parameters:

other - the other SampleSummaryStatistics statistics to combine with this one.

Returns:

this statistics object

Throws:

IllegalArgumentException - if the parameterCount of the other statistics object is different to this one

NullPointerException - if the other statistical summary is null.

getMoments

public ISeq<DoubleMomentStatistics> getMoments()

Return the raw DoubleMomentStatistics objects.

Returns:

the raw DoubleMomentStatistics objects

getQuantiles

public ISeq<org.jenetics.tool.trial.ExactQuantile> getQuantiles()

Return the quantile object.

Returns:

the quantile object

toSampleStatistics

public static Collector<Sample,?,SampleSummaryStatistics> toSampleStatistics(int parameterCount)

Return a Collector which applies an double-producing mapping function to each input element, and returns moments-statistics for the resulting values.

final Stream<Sample> stream = ... final SampleSummaryStatistics statistics = stream .collect(toDoubleMomentStatistics(parameterCount));

Parameters:

parameterCount - the number of parameter of the accumulated Sample objects

Returns:

a Collector implementing the sample reduction

Throws:

IllegalArgumentException - if the given parameterCount is smaller then one