DoubleSummaryStatistics
Defined in: src/util/SummaryStatistics.ts:159
count/sum/min/max/average of doubles. The sum is compensated (Kahan), as in the reference, so long runs of small values don’t drift. Empty: min = Infinity, max = -Infinity.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DoubleSummaryStatistics():
DoubleSummaryStatistics
Defined in: src/util/SummaryStatistics.ts:166
Creates empty statistics (count 0).
Returns
Section titled “Returns”DoubleSummaryStatistics
Constructor
Section titled “Constructor”new DoubleSummaryStatistics(
count,min,max,sum):DoubleSummaryStatistics
Defined in: src/util/SummaryStatistics.ts:172
Creates statistics with the given state. With count 0 the other arguments are ignored.
Parameters
Section titled “Parameters”number
number
number
number
Returns
Section titled “Returns”DoubleSummaryStatistics
Throws
Section titled “Throws”IllegalArgumentException if count < 0, or count > 0 and min > max, or count > 0 and some
but not all of min, max and sum are NaN
Methods
Section titled “Methods”[INSPECT]()
Section titled “[INSPECT]()”[INSPECT]():
string
Defined in: src/util/SummaryStatistics.ts:232
Node’s util.inspect hook: console.log prints the toString() form.
Returns
Section titled “Returns”string
accept()
Section titled “accept()”accept(
value):void
Defined in: src/util/SummaryStatistics.ts:189
Records value: increments the count, adds it to the compensated sum and updates min and max (a NaN makes both NaN).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
combine()
Section titled “combine()”combine(
other):void
Defined in: src/util/SummaryStatistics.ts:200
Merges the state of other into this one, as if every value it recorded had been recorded here.
Parameters
Section titled “Parameters”DoubleSummaryStatistics
Returns
Section titled “Returns”void
Throws
Section titled “Throws”NullPointerException if other is null
getAverage()
Section titled “getAverage()”getAverage():
number
Defined in: src/util/SummaryStatistics.ts:227
Returns the mean of the recorded values (compensated sum divided by count), or 0 when nothing was recorded.
Returns
Section titled “Returns”number
getCount()
Section titled “getCount()”getCount():
number
Defined in: src/util/SummaryStatistics.ts:209
Returns the number of recorded values.
Returns
Section titled “Returns”number
getMax()
Section titled “getMax()”getMax():
number
Defined in: src/util/SummaryStatistics.ts:223
Returns the largest recorded value, -Infinity when empty, or NaN if any value was NaN.
Returns
Section titled “Returns”number
getMin()
Section titled “getMin()”getMin():
number
Defined in: src/util/SummaryStatistics.ts:219
Returns the smallest recorded value, Infinity when empty, or NaN if any value was NaN.
Returns
Section titled “Returns”number
getSum()
Section titled “getSum()”getSum():
number
Defined in: src/util/SummaryStatistics.ts:214
Returns the compensated sum of the recorded values (0 when empty); NaN if any value was NaN.
Returns
Section titled “Returns”number
toString()
Section titled “toString()”toString():
string
Defined in: src/util/SummaryStatistics.ts:236
Returns e.g. DoubleSummaryStatistics{count=2, sum=3.000000, min=1.000000, average=1.500000, max=2.000000}.
Returns
Section titled “Returns”string