Class IntStatistics.Builder

java.lang.Object

org.apache.commons.statistics.descriptive.IntStatistics.Builder

Enclosing class:

IntStatistics

public static final class IntStatistics.Builder
extends Object

A builder for IntStatistics.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
private StatisticsConfiguration	config	Configuration options for computation of statistics.
private Function<int[],IntMax>	max	The IntMax constructor.
private Function<int[],IntMin>	min	The IntMin constructor.
private Function<int[], FirstMoment>	moment	The moment constructor.
private int	momentOrder	The order of the moment.
private static final int[]	NO_VALUES	An empty double array.
private Function<int[],Product>	product	The Product constructor.
private Function<int[],IntSum>	sum	The IntSum constructor.
private Function<int[], SumOfLogs>	sumOfLogs	The SumOfLogs constructor.
private Function<int[], IntSumOfSquares>	sumOfSquares	The IntSumOfSquares constructor.

Constructor Summary

Constructors

Constructor	Description
Builder()	Create an instance.

Method Summary

Modifier and Type	Method	Description
(package private) IntStatistics.Builder	add(Statistic statistic)	Add the statistic to the statistics to compute.
IntStatistics	build()	Builds a IntStatistics instance.
IntStatistics	build(int... values)	Builds a IntStatistics instance using the input values.
private static <T> T	create(Function<int[],T> constructor, int[] values)	Creates the object from the values.
private void	createMoment(int order)	Creates the moment constructor for the specified order, e.g.
IntStatistics.Builder	setConfiguration(StatisticsConfiguration v)	Sets the statistics configuration options for computation of statistics.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_VALUES

private static final int[] NO_VALUES

An empty double array.

min

private Function<int[],IntMin> min

The IntMin constructor.

max

private Function<int[],IntMax> max

The IntMax constructor.

moment

private Function<int[], FirstMoment> moment

The moment constructor. May return any instance of FirstMoment.

sum

private Function<int[],IntSum> sum

The IntSum constructor.

product

private Function<int[],Product> product

The Product constructor.

sumOfSquares

private Function<int[], IntSumOfSquares> sumOfSquares

The IntSumOfSquares constructor.

sumOfLogs

private Function<int[], SumOfLogs> sumOfLogs

The SumOfLogs constructor.

momentOrder

private int momentOrder

The order of the moment. It corresponds to the power computed by the FirstMoment instance constructed by moment. This should only be increased from the default of zero (corresponding to no moment computation).

config

private StatisticsConfiguration config

Configuration options for computation of statistics.

Constructor Details

Builder

Builder()

Create an instance.

Method Details

add

IntStatistics.Builder add(Statistic statistic)

Add the statistic to the statistics to compute.

Parameters:

statistic - Statistic to compute.

Returns:

this instance

createMoment

private void createMoment(int order)

Creates the moment constructor for the specified order, e.g. order=3 is sum of cubed deviations.

Parameters:

order - Order.

setConfiguration

public IntStatistics.Builder setConfiguration(StatisticsConfiguration v)

Sets the statistics configuration options for computation of statistics.

Parameters:

v - Value.

Returns:

the builder

Throws:

NullPointerException - if the value is null

build

public IntStatistics build()

Builds a IntStatistics instance.

Returns:

IntStatistics instance.

build

public IntStatistics build(int... values)

Builds a IntStatistics instance using the input values.

Note: IntStatistics computed using accept may be different from this instance.

Parameters:

values - Values.

Returns:

IntStatistics instance.

create

private static <T> T create(Function<int[],T> constructor,
 int[] values)

Creates the object from the values.

Type Parameters:

T - object type

Parameters:

constructor - Constructor.

values - Values

Returns:

the instance