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 Meanand std is theStandardDeviationNote that this statistic is undefined for n < 4. Double.Nanis 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 SummaryFields Modifier and Type Field Description protected booleanincMomentDetermines whether or not this statistic can be incremented or cleared.protected FourthMomentmomentFourth Moment on which this statistic is based
 - 
Constructor SummaryConstructors Constructor Description Kurtosis()Construct a KurtosisKurtosis(FourthMoment m4)Construct a Kurtosis from an external momentKurtosis(Kurtosis original)Copy constructor, creates a newKurtosisidentical to theoriginal
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clears the internal state of the StatisticKurtosiscopy()Returns a copy of the statistic with the same internal state.static voidcopy(Kurtosis source, Kurtosis dest)Copies source to dest.doubleevaluate(double[] values, int begin, int length)Returns the kurtosis of the entries in the specified portion of the input array.longgetN()Returns the number of values that have been added.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.AbstractStorelessUnivariateStatisticequals, evaluate, hashCode, incrementAll, incrementAll
 - 
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatisticevaluate, getData, getDataRef, setData, setData, test, test
 
- 
 
- 
- 
- 
Field Detail- 
momentprotected FourthMoment moment Fourth Moment on which this statistic is based
 - 
incMomentprotected 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- 
Kurtosispublic Kurtosis() Construct a Kurtosis
 - 
Kurtosispublic Kurtosis(FourthMoment m4) Construct a Kurtosis from an external moment- Parameters:
- m4- external Moment
 
 - 
Kurtosispublic Kurtosis(Kurtosis original) Copy constructor, creates a newKurtosisidentical to theoriginal- Parameters:
- original- the- Kurtosisinstance to copy
 
 
- 
 - 
Method Detail- 
incrementpublic void increment(double d) Updates the internal state of the statistic to reflect the addition of the new value.- Specified by:
- incrementin interface- StorelessUnivariateStatistic
- Specified by:
- incrementin class- AbstractStorelessUnivariateStatistic
- Parameters:
- d- the new value.
 
 - 
getResultpublic double getResult() Returns the current value of the Statistic.- Specified by:
- getResultin interface- StorelessUnivariateStatistic
- Specified by:
- getResultin class- AbstractStorelessUnivariateStatistic
- Returns:
- value of the statistic, Double.NaNif it has been cleared or just instantiated.
 
 - 
clearpublic void clear() Clears the internal state of the Statistic- Specified by:
- clearin interface- StorelessUnivariateStatistic
- Specified by:
- clearin class- AbstractStorelessUnivariateStatistic
 
 - 
getNpublic long getN() Returns the number of values that have been added.- Specified by:
- getNin interface- StorelessUnivariateStatistic
- Returns:
- the number of values.
 
 - 
evaluatepublic double evaluate(double[] values, int begin, int length)Returns the kurtosis of the entries in the specified portion of the input array.See Kurtosisfor details on the computing algorithm.Throws IllegalArgumentExceptionif the array is null.- Specified by:
- evaluatein interface- UnivariateStatistic
- Overrides:
- evaluatein class- AbstractStorelessUnivariateStatistic
- Parameters:
- values- the input array
- begin- index of the first array element to include
- length- 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)
 
 - 
copypublic Kurtosis copy() Returns a copy of the statistic with the same internal state.- Specified by:
- copyin interface- StorelessUnivariateStatistic
- Specified by:
- copyin interface- UnivariateStatistic
- Specified by:
- copyin class- AbstractStorelessUnivariateStatistic
- Returns:
- a copy of the statistic
 
 
- 
 
-