org.jenetics.stat

Class IntSummary

java.lang.Object

org.jenetics.stat.IntSummary

All Implemented Interfaces:

Serializable

public final class IntSummary
extends Object
implements Serializable

Value objects which contains statistical summary information.

Since:

3.0

Version:

3.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

IntSummaryStatistics, Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getCount() Returns the count of values recorded.
int	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.
int	getMin() Return the minimum value recorded, or Integer.MAX_VALUE if no values have been recorded.
long	getSum() Return the sum of values recorded, or zero if no values have been recorded.
int	hashCode()
static IntSummary	of(IntSummaryStatistics statistics) Return a new value object of the statistical summary, currently represented by the statistics object.
static IntSummary	of(long count, int min, int max, long sum, double mean) Create an immutable object which contains statistical summary values.
static <T> Collector<T,?,IntSummary>	toIntSummary(ToIntFunction<? super T> mapper) Return a Collector which applies an int-producing mapping function to each input element, and returns summary-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 int 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 int 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 long 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

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 IntSummary of(long count,
                            int min,
                            int max,
                            long sum,
                            double mean)

Create an immutable object which contains statistical summary 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

Returns:

an immutable object which contains statistical values

of

public static IntSummary of(IntSummaryStatistics statistics)

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

Parameters:

statistics - the creating (mutable) statistics class

Returns:

the statistical moments

toIntSummary

public static <T> Collector<T,?,IntSummary> toIntSummary(ToIntFunction<? super T> mapper)

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

final Stream<SomeObject> stream = ... final IntSummary summary = stream .collect(toIntSummary(v -> v.intValue()));

Type Parameters:

T - the type of the input elements

Parameters:

mapper - a mapping function to apply to each element

Returns:

a Collector implementing the summary-statistics reduction

Throws:

NullPointerException - if the given mapper is null