Class DoubleStatistics.Builder

java.lang.Object

org.apache.commons.statistics.descriptive.DoubleStatistics.Builder

Enclosing class:

DoubleStatistics

public static final class DoubleStatistics.Builder
extends Object

A builder for DoubleStatistics.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
private StatisticsConfiguration	config	Configuration options for computation of statistics.
private RangeFunction<double[],Max>	max	The Max constructor.
private RangeFunction<double[],Min>	min	The Min constructor.
private RangeBiFunction<org.apache.commons.numbers.core.Sum, double[], FirstMoment>	moment	The moment constructor.
private int	momentOrder	The order of the moment.
private static final double[]	NO_VALUES	An empty double array.
private RangeFunction<double[],Product>	product	The Product constructor.
private Function<org.apache.commons.numbers.core.Sum, Sum>	sum	The Sum constructor.
private RangeFunction<double[], SumOfLogs>	sumOfLogs	The SumOfLogs constructor.
private RangeFunction<double[], SumOfSquares>	sumOfSquares	The SumOfSquares constructor.

Constructor Summary

Constructors

Constructor	Description
Builder()	Create an instance.

Method Summary

Modifier and Type	Method	Description
(package private) DoubleStatistics.Builder	add(Statistic statistic)	Add the statistic to the statistics to compute.
DoubleStatistics	build()	Builds a DoubleStatistics instance.
DoubleStatistics	build(double... values)	Builds a DoubleStatistics instance using the input values.
DoubleStatistics	build(double[] values, int from, int to)	Builds a DoubleStatistics instance using the specified range of values.
private DoubleStatistics	create(double[] values, int from, int to)	Builds a DoubleStatistics instance using the input values.
private static <S,T> T	create(Function<S,T> constructor, S values)	Creates the object from the values.
private static <R,S,T> T	create(RangeBiFunction<R,S,T> constructor, R r, S s, int from, int to)	Creates the object from the values r and s.
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.
DoubleStatistics.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 double[] NO_VALUES

An empty double array.

min

private RangeFunction<double[],Min> min

The Min constructor.

max

private RangeFunction<double[],Max> max

The Max constructor.

moment

private RangeBiFunction<org.apache.commons.numbers.core.Sum, double[], FirstMoment> moment

The moment constructor. May return any instance of FirstMoment.

sum

private Function<org.apache.commons.numbers.core.Sum, Sum> sum

The Sum constructor.

product

private RangeFunction<double[],Product> product

The Product constructor.

sumOfSquares

private RangeFunction<double[], SumOfSquares> sumOfSquares

The SumOfSquares constructor.

sumOfLogs

private RangeFunction<double[], 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

DoubleStatistics.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=2 is sum of squared deviations.

Parameters:

order - Order.

setConfiguration

public DoubleStatistics.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 DoubleStatistics build()

Builds a DoubleStatistics instance.

Returns:

DoubleStatistics instance.

build

public DoubleStatistics build(double... values)

Builds a DoubleStatistics instance using the input values.

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

Parameters:

values - Values.

Returns:

DoubleStatistics instance.

build

public DoubleStatistics build(double[] values,
 int from,
 int to)

Builds a DoubleStatistics instance using the specified range of values.

Note: DoubleStatistics 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:

DoubleStatistics instance.

Throws:

IndexOutOfBoundsException - if the sub-range is out of bounds

Since:

1.2

create

private DoubleStatistics create(double[] values,
 int from,
 int to)

Builds a DoubleStatistics instance using the input values.

Note: DoubleStatistics 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:

DoubleStatistics instance.

create

private static <S,T> T create(Function<S,T> constructor,
 S values)

Creates the object from the values.

Type Parameters:

S - value type

T - object type

Parameters:

constructor - Constructor.

values - Values

Returns:

the 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

create

private static <R,S,T> T create(RangeBiFunction<R,S,T> constructor,
 R r,
 S s,
 int from,
 int to)

Creates the object from the values r and s.

Type Parameters:

R - value type

S - value type

T - object type

Parameters:

constructor - Constructor.

r - Value.

s - Value.

from - Inclusive start of the range.

to - Exclusive end of the range.

Returns:

the instance