Class AbstractUnivariateStatistic
- java.lang.Object
-
- org.apache.commons.math4.legacy.stat.descriptive.AbstractUnivariateStatistic
-
- All Implemented Interfaces:
MathArrays.Function,UnivariateStatistic
- Direct Known Subclasses:
Percentile,SemiVariance
public abstract class AbstractUnivariateStatistic extends Object implements UnivariateStatistic
Abstract base class for implementations of theUnivariateStatisticinterface.Provides a default implementation of
evaluate(double[]),delegating toevaluate(double[], int, int)in the natural way.
-
-
Constructor Summary
Constructors Constructor Description AbstractUnivariateStatistic()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract UnivariateStatisticcopy()Returns a copy of the statistic with the same internal state.doubleevaluate()Returns the result of evaluating the statistic over the stored data.doubleevaluate(double[] values)Returns the result of evaluating the statistic over the input array.abstract doubleevaluate(double[] values, int begin, int length)Returns the result of evaluating the statistic over the specified entries in the input array.double[]getData()Get a copy of the stored data array.protected double[]getDataRef()Get a reference to the stored data array.voidsetData(double[] values)Set the data array.voidsetData(double[] values, int begin, int length)Set the data array.
-
-
-
Constructor Detail
-
AbstractUnivariateStatistic
public AbstractUnivariateStatistic()
-
-
Method Detail
-
evaluate
public double evaluate(double[] values) throws MathIllegalArgumentException
Returns the result of evaluating the statistic over the input array.- Specified by:
evaluatein interfaceMathArrays.Function- Specified by:
evaluatein interfaceUnivariateStatistic- Parameters:
values- input array- Returns:
- the value of the statistic applied to the input array
- Throws:
MathIllegalArgumentException- if values is null
-
evaluate
public abstract double evaluate(double[] values, int begin, int length) throws MathIllegalArgumentException
Returns the result of evaluating the statistic over the specified entries in the input array.- Specified by:
evaluatein interfaceMathArrays.Function- Specified by:
evaluatein interfaceUnivariateStatistic- Parameters:
values- the input arraybegin- the index of the first element to includelength- the number of elements to include- Returns:
- the value of the statistic applied to the included array entries
- Throws:
MathIllegalArgumentException- if values is null or the indices are invalid
-
copy
public abstract UnivariateStatistic copy()
Returns a copy of the statistic with the same internal state.- Specified by:
copyin interfaceUnivariateStatistic- Returns:
- a copy of the statistic
-
setData
public void setData(double[] values)
Set the data array.The stored value is a copy of the parameter array, not the array itself.
- Parameters:
values- data array to store (may be null to remove stored data)- See Also:
evaluate()
-
getData
public double[] getData()
Get a copy of the stored data array.- Returns:
- copy of the stored data array (may be null)
-
getDataRef
protected double[] getDataRef()
Get a reference to the stored data array.- Returns:
- reference to the stored data array (may be null)
-
setData
public void setData(double[] values, int begin, int length) throws MathIllegalArgumentException
Set the data array. The input array is copied, not referenced.- Parameters:
values- data array to storebegin- the index of the first element to includelength- the number of elements to include- Throws:
MathIllegalArgumentException- if values is null or the indices are not valid- See Also:
evaluate()
-
evaluate
public double evaluate() throws MathIllegalArgumentException
Returns the result of evaluating the statistic over the stored data.The stored array is the one which was set by previous calls to
setData(double[]).- Returns:
- the value of the statistic applied to the stored data
- Throws:
MathIllegalArgumentException- if the stored data array is null
-
-