Package org.apache.commons.statistics.descriptive

Class IntStatistics.Builder

java.lang.Object

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

Enclosing class:

IntStatistics

public static final class IntStatistics.Builder
extends java.lang.Object

A builder for IntStatistics.

Field Summary

Fields

Modifier and Type	Field	Description
private StatisticsConfiguration	config	Configuration options for computation of statistics.
private RangeFunction<int[],IntMax>	max	The IntMax constructor.
private RangeFunction<int[],IntMin>	min	The IntMin constructor.
private RangeFunction<int[],FirstMoment>	moment	The moment constructor.
private int	momentOrder	The order of the moment.
private static int[]	NO_VALUES	An empty double array.
private RangeFunction<int[],Product>	product	The Product constructor.
private RangeFunction<int[],IntSum>	sum	The IntSum constructor.
private RangeFunction<int[],SumOfLogs>	sumOfLogs	The SumOfLogs constructor.
private RangeFunction<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 an IntStatistics instance.
IntStatistics	build(int... values)	Builds an IntStatistics instance using the input values.
IntStatistics	build(int[] values, int from, int to)	Builds an IntStatistics instance using the specified range of values.
private IntStatistics	create(int[] values, int from, int to)	Builds an IntStatistics instance using the input values.
private static <S,T> T	create(RangeFunction<S,T> constructor, S values, int from, int to)	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 java.lang.Object

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

Field Detail

NO_VALUES

private static final int[] NO_VALUES

An empty double array.

min

private RangeFunction<int[],IntMin> min

The IntMin constructor.

max

private RangeFunction<int[],IntMax> max

The IntMax constructor.

moment

private RangeFunction<int[],FirstMoment> moment

The moment constructor. May return any instance of FirstMoment.

sum

private RangeFunction<int[],IntSum> sum

The IntSum constructor.

product

private RangeFunction<int[],Product> product

The Product constructor.

sumOfSquares

private RangeFunction<int[],IntSumOfSquares> sumOfSquares

The IntSumOfSquares constructor.

sumOfLogs

private RangeFunction<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 Detail

Builder

Builder()

Create an instance.

Method Detail

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:

java.lang.NullPointerException - if the value is null

build

public IntStatistics build()

Builds an IntStatistics instance.

Returns:

IntStatistics instance.

build

public IntStatistics build(int... values)

Builds an IntStatistics instance using the input values.

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

Parameters:

values - Values.

Returns:

IntStatistics instance.

build

public IntStatistics build(int[] values,
                           int from,
                           int to)

Builds an IntStatistics instance using the specified range of values.

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

Parameters:

values - Values.

from - Inclusive start of the range.

to - Exclusive end of the range.

Returns:

IntStatistics instance.

Throws:

java.lang.IndexOutOfBoundsException - if the sub-range is out of bounds

Since:

1.2

create

private IntStatistics create(int[] values,
                             int from,
                             int to)

Builds an IntStatistics instance using the input values.

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

Warning: No range checks are performed.

Parameters:

values - Values.

from - Inclusive start of the range.

to - Exclusive end of the range.

Returns:

IntStatistics instance.

create

private static <S,T> T create(RangeFunction<S,T> constructor,
                                    S values,
                                    int from,
                                    int to)

Creates the object from the values.

Type Parameters:

S - value type

T - object type

Parameters:

constructor - Constructor.

values - Values

from - Inclusive start of the range.

to - Exclusive end of the range.

Returns:

the instance