org.jenetics.stat

Class DoubleMoments

java.lang.Object

org.jenetics.stat.DoubleMoments

All Implemented Interfaces:

Serializable

public final class DoubleMoments
extends Object
implements Serializable

Value objects which contains statistical moments.

Since:

3.0

Version:

3.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

DoubleMomentStatistics, Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getCount() Returns the count of values recorded.
double	getKurtosis() Return the kurtosis of values recorded, or Double.NaN if less than four values have been recorded.
double	getMax() Return the maximum value recorded, or Integer.MIN_VALUE if no values have been recorded.
double	getMean() Return the arithmetic mean of values recorded, or zero if no values have been recorded.
double	getMin() Return the minimum value recorded, or Integer.MAX_VALUE if no values have been recorded.
double	getSkewness() Return the skewness of values recorded, or Double.NaN if less than two values have been recorded.
double	getSum() Return the sum of values recorded, or zero if no values have been recorded.
double	getVariance() Return the variance of values recorded, or Double.NaN if no values have been recorded.
int	hashCode()
static DoubleMoments	of(DoubleMomentStatistics statistics) Return a new value object of the statistical moments, currently represented by the statistics object.
static DoubleMoments	of(long count, double min, double max, double sum, double mean, double variance, double skewness, double kurtosis) Create an immutable object which contains statistical values.
static <T> Collector<T,?,DoubleMoments>	toDoubleMoments(ToDoubleFunction<? super T> mapper) Return a Collector which applies an double-producing mapping function to each input element, and returns moments-statistics for the resulting values.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCount

public long getCount()

Returns the count of values recorded.

Returns:

the count of recorded values

getMin

public double getMin()

Return the minimum value recorded, or Integer.MAX_VALUE if no values have been recorded.

Returns:

the minimum value, or Integer.MAX_VALUE if none

getMax

public double getMax()

Return the maximum value recorded, or Integer.MIN_VALUE if no values have been recorded.

Returns:

the maximum value, or Integer.MIN_VALUE if none

getSum

public double getSum()

Return the sum of values recorded, or zero if no values have been recorded.

Returns:

the sum of values, or zero if none

getMean

public double getMean()

Return the arithmetic mean of values recorded, or zero if no values have been recorded.

Returns:

the arithmetic mean of values, or zero if none

getVariance

public double getVariance()

Return the variance of values recorded, or Double.NaN if no values have been recorded.

Returns:

the variance of values, or NaN if none

getSkewness

public double getSkewness()

Return the skewness of values recorded, or Double.NaN if less than two values have been recorded.

Returns:

the skewness of values, or NaN if less than two values have been recorded

See Also:

Skewness

getKurtosis

public double getKurtosis()

Return the kurtosis of values recorded, or Double.NaN if less than four values have been recorded.

Returns:

the kurtosis of values, or NaN if less than four values have been recorded

See Also:

Kurtosis

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static DoubleMoments of(long count,
                               double min,
                               double max,
                               double sum,
                               double mean,
                               double variance,
                               double skewness,
                               double kurtosis)

Create an immutable object which contains statistical values.

Parameters:

count - the count of values recorded

min - the minimum value

max - the maximum value

sum - the sum of the recorded values

mean - the arithmetic mean of values

variance - the variance of values

skewness - the skewness of values

kurtosis - the kurtosis of values

Returns:

an immutable object which contains statistical values

of

public static DoubleMoments of(DoubleMomentStatistics statistics)

Return a new value object of the statistical moments, currently represented by the statistics object.

Parameters:

statistics - the creating (mutable) statistics class

Returns:

the statistical moments

toDoubleMoments

public static <T> Collector<T,?,DoubleMoments> toDoubleMoments(ToDoubleFunction<? super T> mapper)

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

final Stream<SomeObject> stream = ... final DoubleMoments moments = stream .collect(toDoubleMoments(v -> v.doubleValue()));

Type Parameters:

T - the type of the input elements

Parameters:

mapper - a mapping function to apply to each element

Returns:

a Collector implementing the moments-statistics reduction

Throws:

NullPointerException - if the given mapper is null