Class FirstMoment
- 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
-
- All Implemented Interfaces:
java.io.Serializable
,StorelessUnivariateStatistic
,UnivariateStatistic
- Direct Known Subclasses:
SecondMoment
public class FirstMoment extends AbstractStorelessUnivariateStatistic implements java.io.Serializable
Computes the first moment (arithmetic mean). Uses the definitional formula:mean = sum(x_i) / n
where
n
is the number of observations.To limit numeric errors, the value of the statistic is computed using the following recursive updating algorithm:
- Initialize
m =
the first value - For each additional value, update using
m = m + (new value - m) / (number of observations)
Returns
Double.NaN
if the dataset is empty.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 FirstMoment()
Create a FirstMoment instanceFirstMoment(FirstMoment original)
Copy constructor, creates a newFirstMoment
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 StatisticFirstMoment
copy()
Returns a copy of the statistic with the same internal state.static void
copy(FirstMoment source, FirstMoment dest)
Copies source to dest.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, evaluate, hashCode, incrementAll, incrementAll
-
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
evaluate, getData, setData, setData
-
-
-
-
Constructor Detail
-
FirstMoment
public FirstMoment()
Create a FirstMoment instance
-
FirstMoment
public FirstMoment(FirstMoment original)
Copy constructor, creates a newFirstMoment
identical to theoriginal
- Parameters:
original
- theFirstMoment
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.
-
clear
public void clear()
Clears the internal state of the Statistic- Specified by:
clear
in interfaceStorelessUnivariateStatistic
- Specified by:
clear
in classAbstractStorelessUnivariateStatistic
-
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.
-
getN
public long getN()
Returns the number of values that have been added.- Specified by:
getN
in interfaceStorelessUnivariateStatistic
- Returns:
- the number of values.
-
copy
public FirstMoment 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
-
copy
public static void copy(FirstMoment source, FirstMoment dest)
Copies source to dest.Neither source nor dest can be null.
- Parameters:
source
- FirstMoment to copydest
- FirstMoment to copy to- Throws:
java.lang.NullPointerException
- if either source or dest is null
-
-