public class VarianceCalculatorDouble extends Object
double
to store
sums internally.
This is similar to VarianceCalculatorLong
but is designed for double
values
rather than int
s.
Efficiency occurs by maintaining a running sum, sum-of-squares and count as values are added.
This is useful for calculating variance in sequential order in an online manner.
Constructor and Description |
---|
VarianceCalculatorDouble() |
VarianceCalculatorDouble(double sum,
double sumSquares,
long count) |
Modifier and Type | Method and Description |
---|---|
void |
add(double value)
Adds a value to the running sum.
|
long |
getCount()
The running count of values.
|
double |
mean()
Calculate the mean, based on the current state of running-sums.
|
VarianceCalculatorDouble |
subtract(VarianceCalculatorDouble toSubtract)
Subtracts the running-sums and count from another
VarianceCalculatorDouble from the
current object's state. |
double |
variance()
Calculate the variance, based on the current state of running-sums.
|
public VarianceCalculatorDouble(double sum, double sumSquares, long count)
public VarianceCalculatorDouble()
public void add(double value)
value
- the value to add.public VarianceCalculatorDouble subtract(VarianceCalculatorDouble toSubtract)
VarianceCalculatorDouble
from the
current object's state.
This occurs immutably, and the currently object's state is unaffected.
toSubtract
- the other VarianceCalculatorDouble
whose state is subtracted.VarianceCalculatorDouble
whose state is the current object
minus toSubtract
.public double mean()
public double variance()
public long getCount()
Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.