Class ThirdMoment
- java.lang.Object
-
- org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
-
- org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic
-
- org.apache.commons.math.stat.descriptive.moment.FirstMoment
-
- org.apache.commons.math.stat.descriptive.moment.SecondMoment
-
- org.apache.commons.math.stat.descriptive.moment.ThirdMoment
-
- All Implemented Interfaces:
java.io.Serializable,StorelessUnivariateStatistic,UnivariateStatistic
- Direct Known Subclasses:
FourthMoment
public class ThirdMoment extends SecondMoment implements java.io.Serializable
Computes a statistic related to the Third Central Moment. Specifically, what is computed is the sum of cubed deviations from the sample mean.The following recursive updating formula is used:
Let
- dev = (current obs - previous mean)
- m2 = previous value of
SecondMoment - n = number of observations (including current obs)
new value = old value - 3 * (dev/n) * m2 + (n-1) * (n -2) * (dev^3/n^2)
Returns
Double.NaNif no data values have been added and returns0if 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()orclear()method, it must be synchronized externally.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ThirdMoment()Create a FourthMoment instanceThirdMoment(ThirdMoment original)Copy constructor, creates a newThirdMomentidentical to theoriginal
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clears the internal state of the StatisticThirdMomentcopy()Returns a copy of the statistic with the same internal state.static voidcopy(ThirdMoment source, ThirdMoment dest)Copies source to dest.doublegetResult()Returns the current value of the Statistic.voidincrement(double d)Updates the internal state of the statistic to reflect the addition of the new value.-
Methods inherited from class org.apache.commons.math.stat.descriptive.moment.SecondMoment
copy
-
Methods inherited from class org.apache.commons.math.stat.descriptive.moment.FirstMoment
copy, getN
-
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic
equals, evaluate, evaluate, hashCode, incrementAll, incrementAll
-
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
evaluate, getData, setData, setData
-
-
-
-
Constructor Detail
-
ThirdMoment
public ThirdMoment()
Create a FourthMoment instance
-
ThirdMoment
public ThirdMoment(ThirdMoment original)
Copy constructor, creates a newThirdMomentidentical to theoriginal- Parameters:
original- theThirdMomentinstance to copy
-
-
Method Detail
-
increment
public void increment(double d)
Updates the internal state of the statistic to reflect the addition of the new value.- Specified by:
incrementin interfaceStorelessUnivariateStatistic- Overrides:
incrementin classSecondMoment- Parameters:
d- the new value.
-
getResult
public double getResult()
Returns the current value of the Statistic.- Specified by:
getResultin interfaceStorelessUnivariateStatistic- Overrides:
getResultin classSecondMoment- Returns:
- value of the statistic,
Double.NaNif it has been cleared or just instantiated.
-
clear
public void clear()
Clears the internal state of the Statistic- Specified by:
clearin interfaceStorelessUnivariateStatistic- Overrides:
clearin classSecondMoment
-
copy
public ThirdMoment copy()
Returns a copy of the statistic with the same internal state.- Specified by:
copyin interfaceStorelessUnivariateStatistic- Specified by:
copyin interfaceUnivariateStatistic- Overrides:
copyin classSecondMoment- Returns:
- a copy of the statistic
-
copy
public static void copy(ThirdMoment source, ThirdMoment dest)
Copies source to dest.Neither source nor dest can be null.
- Parameters:
source- ThirdMoment to copydest- ThirdMoment to copy to- Throws:
java.lang.NullPointerException- if either source or dest is null
-
-