Class SumOfSquares
- java.lang.Object
-
- org.apache.commons.math4.legacy.stat.descriptive.AbstractStorelessUnivariateStatistic
-
- org.apache.commons.math4.legacy.stat.descriptive.summary.SumOfSquares
-
- All Implemented Interfaces:
MathArrays.Function,StorelessUnivariateStatistic,UnivariateStatistic
public class SumOfSquares extends AbstractStorelessUnivariateStatistic
Returns the sum of the squares of the available values.If there are no values in the dataset, then 0 is returned. If any of the values are
NaN, thenNaNis returned.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.
-
-
Constructor Summary
Constructors Constructor Description SumOfSquares()Create a SumOfSquares instance.SumOfSquares(SumOfSquares original)Copy constructor, creates a newSumOfSquaresidentical to theoriginal.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clears the internal state of the Statistic.SumOfSquarescopy()Returns a copy of the statistic with the same internal state.static voidcopy(SumOfSquares source, SumOfSquares dest)Copies source to dest.doubleevaluate(double[] values, int begin, int length)Returns the sum of the squares of the entries in the specified portion of the input array, orDouble.NaNif the designated subarray is empty.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.math4.legacy.stat.descriptive.AbstractStorelessUnivariateStatistic
equals, evaluate, hashCode, incrementAll, incrementAll
-
-
-
-
Constructor Detail
-
SumOfSquares
public SumOfSquares()
Create a SumOfSquares instance.
-
SumOfSquares
public SumOfSquares(SumOfSquares original) throws NullArgumentException
Copy constructor, creates a newSumOfSquaresidentical to theoriginal.- Parameters:
original- theSumOfSquaresinstance to copy- Throws:
NullArgumentException- if original is null
-
-
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- Specified by:
incrementin classAbstractStorelessUnivariateStatistic- Parameters:
d- the new value.
-
getResult
public double getResult()
Returns the current value of the Statistic.- Specified by:
getResultin interfaceStorelessUnivariateStatistic- Specified by:
getResultin classAbstractStorelessUnivariateStatistic- Returns:
- value of the statistic,
Double.NaNif it has been cleared or just instantiated.
-
getN
public long getN()
Returns the number of values that have been added.- Returns:
- the number of values.
-
clear
public void clear()
Clears the internal state of the Statistic.- Specified by:
clearin interfaceStorelessUnivariateStatistic- Specified by:
clearin classAbstractStorelessUnivariateStatistic
-
evaluate
public double evaluate(double[] values, int begin, int length) throws MathIllegalArgumentException
Returns the sum of the squares of the entries in the specified portion of the input array, orDouble.NaNif the designated subarray is empty.Throws
MathIllegalArgumentExceptionif the array is null.- Specified by:
evaluatein interfaceMathArrays.Function- Specified by:
evaluatein interfaceUnivariateStatistic- Overrides:
evaluatein classAbstractStorelessUnivariateStatistic- Parameters:
values- the input arraybegin- index of the first array element to includelength- the number of elements to include- Returns:
- the sum of the squares of the values or 0 if length = 0
- Throws:
MathIllegalArgumentException- if the array is null or the array index parameters are not valid- See Also:
UnivariateStatistic.evaluate(double[], int, int)
-
copy
public SumOfSquares copy()
Returns a copy of the statistic with the same internal state.- Specified by:
copyin interfaceStorelessUnivariateStatistic- Specified by:
copyin interfaceUnivariateStatistic- Specified by:
copyin classAbstractStorelessUnivariateStatistic- Returns:
- a copy of the statistic
-
copy
public static void copy(SumOfSquares source, SumOfSquares dest) throws NullArgumentException
Copies source to dest.Neither source nor dest can be null.
- Parameters:
source- SumOfSquares to copydest- SumOfSquares to copy to- Throws:
NullArgumentException- if either source or dest is null
-
-