Class LongStatistics.Builder
java.lang.Object
org.apache.commons.statistics.descriptive.LongStatistics.Builder
- Enclosing class:
LongStatistics
A builder for
LongStatistics
.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StatisticsConfiguration
Configuration options for computation of statistics.TheLongMax
constructor.TheLongMin
constructor.private Function
<long[], FirstMoment> The moment constructor.private int
The order of the moment.private static final long[]
An empty double array.TheProduct
constructor.TheLongSum
constructor.TheSumOfLogs
constructor.private Function
<long[], LongSumOfSquares> TheLongSumOfSquares
constructor. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) LongStatistics.Builder
Add the statistic to the statistics to compute.build()
Builds aLongStatistics
instance.build
(long... values) Builds aLongStatistics
instance using the inputvalues
.private static <T> T
Creates the object from thevalues
.private void
createMoment
(int order) Creates the moment constructor for the specifiedorder
, e.g.Sets the statistics configuration options for computation of statistics.
-
Field Details
-
NO_VALUES
private static final long[] NO_VALUESAn empty double array. -
min
TheLongMin
constructor. -
max
TheLongMax
constructor. -
moment
The moment constructor. May return any instance ofFirstMoment
. -
sum
TheLongSum
constructor. -
product
TheProduct
constructor. -
sumOfSquares
TheLongSumOfSquares
constructor. -
sumOfLogs
TheSumOfLogs
constructor. -
momentOrder
private int momentOrderThe order of the moment. It corresponds to the power computed by theFirstMoment
instance constructed bymoment
. This should only be increased from the default of zero (corresponding to no moment computation). -
config
Configuration options for computation of statistics.
-
-
Constructor Details
-
Builder
Builder()Create an instance.
-
-
Method Details
-
add
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 specifiedorder
, e.g. order=3 is sum of cubed deviations.- Parameters:
order
- Order.
-
setConfiguration
Sets the statistics configuration options for computation of statistics.- Parameters:
v
- Value.- Returns:
- the builder
- Throws:
NullPointerException
- if the value is null
-
build
Builds aLongStatistics
instance.- Returns:
LongStatistics
instance.
-
build
Builds aLongStatistics
instance using the inputvalues
.Note:
LongStatistics
computed usingaccept
may be different from this instance.- Parameters:
values
- Values.- Returns:
LongStatistics
instance.
-
create
Creates the object from thevalues
.- Type Parameters:
T
- object type- Parameters:
constructor
- Constructor.values
- Values- Returns:
- the instance
-