public class SecondMoment extends FirstMoment implements java.io.Serializable
The following recursive updating formula is used:
Let
new value = old value + dev^2 * (n -1) / n.
Returns Double.NaN if no data values have been added and
returns 0 if there is just one value in the data set.
Note that this implementation is not synchronized. If
multiple threads access an instance of this class concurrently, and at least
one of the threads invokes the increment() or
clear() method, it must be synchronized externally.
| Modifier and Type | Field and Description |
|---|---|
protected double |
m2
second moment of values that have been added
|
dev, m1, n, nDev| Constructor and Description |
|---|
SecondMoment()
Create a SecondMoment instance
|
SecondMoment(SecondMoment original)
Copy constructor, creates a new
SecondMoment identical
to the original |
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Clears the internal state of the Statistic
|
SecondMoment |
copy()
Returns a copy of the statistic with the same internal state.
|
static void |
copy(SecondMoment source,
SecondMoment dest)
Copies source to dest.
|
double |
getResult()
Returns the current value of the Statistic.
|
void |
increment(double d)
Updates the internal state of the statistic to reflect the addition of the new value.
|
copy, getNequals, evaluate, evaluate, hashCode, incrementAll, incrementAlltest, testpublic SecondMoment()
public SecondMoment(SecondMoment original)
SecondMoment identical
to the originaloriginal - the SecondMoment instance to copypublic void increment(double d)
increment in interface StorelessUnivariateStatisticincrement in class FirstMomentd - the new value.public void clear()
clear in interface StorelessUnivariateStatisticclear in class FirstMomentpublic double getResult()
getResult in interface StorelessUnivariateStatisticgetResult in class FirstMomentDouble.NaN if it
has been cleared or just instantiated.public SecondMoment copy()
copy in interface StorelessUnivariateStatisticcopy in interface UnivariateStatisticcopy in class FirstMomentpublic static void copy(SecondMoment source, SecondMoment dest)
Neither source nor dest can be null.
source - SecondMoment to copydest - SecondMoment to copy tojava.lang.NullPointerException - if either source or dest is null