Class Kurtosis
- java.lang.Object
-
- org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
-
- org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic
-
- org.apache.commons.math.stat.descriptive.moment.Kurtosis
-
- All Implemented Interfaces:
java.io.Serializable
,StorelessUnivariateStatistic
,UnivariateStatistic
public class Kurtosis extends AbstractStorelessUnivariateStatistic implements java.io.Serializable
Computes the Kurtosis of the available values.We use the following (unbiased) formula to define kurtosis:
kurtosis = { [n(n+1) / (n -1)(n - 2)(n-3)] sum[(x_i - mean)^4] / std^4 } - [3(n-1)^2 / (n-2)(n-3)]
where n is the number of values, mean is the
Mean
and std is theStandardDeviation
Note that this statistic is undefined for n < 4.
Double.Nan
is returned when there is not sufficient data to compute the statistic.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.- Version:
- $Revision: 1006299 $ $Date: 2010-10-10 16:47:17 +0200 (dim. 10 oct. 2010) $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
incMoment
Determines whether or not this statistic can be incremented or cleared.protected FourthMoment
moment
Fourth Moment on which this statistic is based
-
Constructor Summary
Constructors Constructor Description Kurtosis()
Construct a KurtosisKurtosis(FourthMoment m4)
Construct a Kurtosis from an external momentKurtosis(Kurtosis original)
Copy constructor, creates a newKurtosis
identical to theoriginal
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clears the internal state of the StatisticKurtosis
copy()
Returns a copy of the statistic with the same internal state.static void
copy(Kurtosis source, Kurtosis dest)
Copies source to dest.double
evaluate(double[] values, int begin, int length)
Returns the kurtosis of the entries in the specified portion of the input array.long
getN()
Returns the number of values that have been added.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.-
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic
equals, evaluate, hashCode, incrementAll, incrementAll
-
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
evaluate, getData, getDataRef, setData, setData, test, test
-
-
-
-
Field Detail
-
moment
protected FourthMoment moment
Fourth Moment on which this statistic is based
-
incMoment
protected boolean incMoment
Determines whether or not this statistic can be incremented or cleared.Statistics based on (constructed from) external moments cannot be incremented or cleared.
-
-
Constructor Detail
-
Kurtosis
public Kurtosis()
Construct a Kurtosis
-
Kurtosis
public Kurtosis(FourthMoment m4)
Construct a Kurtosis from an external moment- Parameters:
m4
- external Moment
-
Kurtosis
public Kurtosis(Kurtosis original)
Copy constructor, creates a newKurtosis
identical to theoriginal
- Parameters:
original
- theKurtosis
instance 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:
increment
in interfaceStorelessUnivariateStatistic
- Specified by:
increment
in classAbstractStorelessUnivariateStatistic
- Parameters:
d
- the new value.
-
getResult
public double getResult()
Returns the current value of the Statistic.- Specified by:
getResult
in interfaceStorelessUnivariateStatistic
- Specified by:
getResult
in classAbstractStorelessUnivariateStatistic
- Returns:
- value of the statistic,
Double.NaN
if it has been cleared or just instantiated.
-
clear
public void clear()
Clears the internal state of the Statistic- Specified by:
clear
in interfaceStorelessUnivariateStatistic
- Specified by:
clear
in classAbstractStorelessUnivariateStatistic
-
getN
public long getN()
Returns the number of values that have been added.- Specified by:
getN
in interfaceStorelessUnivariateStatistic
- Returns:
- the number of values.
-
evaluate
public double evaluate(double[] values, int begin, int length)
Returns the kurtosis of the entries in the specified portion of the input array.See
Kurtosis
for details on the computing algorithm.Throws
IllegalArgumentException
if the array is null.- Specified by:
evaluate
in interfaceUnivariateStatistic
- Overrides:
evaluate
in classAbstractStorelessUnivariateStatistic
- Parameters:
values
- the input arraybegin
- index of the first array element to includelength
- the number of elements to include- Returns:
- the kurtosis of the values or Double.NaN if length is less than 4
- Throws:
java.lang.IllegalArgumentException
- if the input array is null or the array index parameters are not valid- See Also:
UnivariateStatistic.evaluate(double[], int, int)
-
copy
public Kurtosis copy()
Returns a copy of the statistic with the same internal state.- Specified by:
copy
in interfaceStorelessUnivariateStatistic
- Specified by:
copy
in interfaceUnivariateStatistic
- Specified by:
copy
in classAbstractStorelessUnivariateStatistic
- Returns:
- a copy of the statistic
-
-