|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math3.stat.descriptive.AbstractUnivariateStatistic
public abstract class AbstractUnivariateStatistic
Abstract base class for all implementations of the
UnivariateStatistic interface.
Provides a default implementation of evaluate(double[]),
delegating to evaluate(double[], int, int) in the natural way.
Also includes a test method that performs generic parameter
validation for the evaluate methods.
| Constructor Summary | |
|---|---|
AbstractUnivariateStatistic()
|
|
| Method Summary | |
|---|---|
abstract UnivariateStatistic |
copy()
Returns a copy of the statistic with the same internal state. |
double |
evaluate()
Returns the result of evaluating the statistic over the stored data. |
double |
evaluate(double[] values)
Returns the result of evaluating the statistic over the input array. |
abstract double |
evaluate(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. |
void |
setData(double[] values)
Set the data array. |
void |
setData(double[] values,
int begin,
int length)
Set the data array. |
protected boolean |
test(double[] values,
double[] weights,
int begin,
int length)
This method is used by evaluate(double[], double[], int, int) methods
to verify that the begin and length parameters designate a subarray of positive length
and the weights are all non-negative, non-NaN, finite, and not all zero. |
protected boolean |
test(double[] values,
double[] weights,
int begin,
int length,
boolean allowEmpty)
This method is used by evaluate(double[], double[], int, int) methods
to verify that the begin and length parameters designate a subarray of positive length
and the weights are all non-negative, non-NaN, finite, and not all zero. |
protected boolean |
test(double[] values,
int begin,
int length)
This method is used by evaluate(double[], int, int) methods
to verify that the input parameters designate a subarray of positive length. |
protected boolean |
test(double[] values,
int begin,
int length,
boolean allowEmpty)
This method is used by evaluate(double[], int, int) methods
to verify that the input parameters designate a subarray of positive length. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractUnivariateStatistic()
| Method Detail |
|---|
public void setData(double[] values)
The stored value is a copy of the parameter array, not the array itself.
values - data array to store (may be null to remove stored data)evaluate()public double[] getData()
protected double[] getDataRef()
public void setData(double[] values,
int begin,
int length)
throws MathIllegalArgumentException
values - data array to storebegin - the index of the first element to includelength - the number of elements to include
MathIllegalArgumentException - if values is null or the indices
are not validevaluate()
public double evaluate()
throws MathIllegalArgumentException
The stored array is the one which was set by previous calls to setData(double[]).
MathIllegalArgumentException - if the stored data array is null
public double evaluate(double[] values)
throws MathIllegalArgumentException
evaluate in interface UnivariateStatisticevaluate in interface MathArrays.Functionvalues - input array
MathIllegalArgumentException - if values is null
public abstract double evaluate(double[] values,
int begin,
int length)
throws MathIllegalArgumentException
evaluate in interface UnivariateStatisticevaluate in interface MathArrays.Functionvalues - the input arraybegin - the index of the first element to includelength - the number of elements to include
MathIllegalArgumentException - if values is null or the indices are invalidpublic abstract UnivariateStatistic copy()
copy in interface UnivariateStatistic
protected boolean test(double[] values,
int begin,
int length)
throws MathIllegalArgumentException
evaluate(double[], int, int) methods
to verify that the input parameters designate a subarray of positive length.
true iff the parameters designate a subarray of
positive lengthMathIllegalArgumentException if the array is null or
or the indices are invalidfalselength is 0.
values - the input arraybegin - index of the first array element to includelength - the number of elements to include
MathIllegalArgumentException - if the indices are invalid or the array is null
protected boolean test(double[] values,
int begin,
int length,
boolean allowEmpty)
throws MathIllegalArgumentException
evaluate(double[], int, int) methods
to verify that the input parameters designate a subarray of positive length.
true iff the parameters designate a subarray of
non-negative lengthIllegalArgumentException if the array is null or
or the indices are invalidfalselength is 0 unless allowEmpty is true
values - the input arraybegin - index of the first array element to includelength - the number of elements to includeallowEmpty - if true then zero length arrays are allowed
MathIllegalArgumentException - if the indices are invalid or the array is null
protected boolean test(double[] values,
double[] weights,
int begin,
int length)
throws MathIllegalArgumentException
evaluate(double[], double[], int, int) methods
to verify that the begin and length parameters designate a subarray of positive length
and the weights are all non-negative, non-NaN, finite, and not all zero.
true iff the parameters designate a subarray of
positive length and the weights array contains legitimate values.IllegalArgumentException if any of the following are true:
falselength is 0.
values - the input arrayweights - the weights arraybegin - index of the first array element to includelength - the number of elements to include
MathIllegalArgumentException - if the indices are invalid or the array is null
protected boolean test(double[] values,
double[] weights,
int begin,
int length,
boolean allowEmpty)
throws MathIllegalArgumentException
evaluate(double[], double[], int, int) methods
to verify that the begin and length parameters designate a subarray of positive length
and the weights are all non-negative, non-NaN, finite, and not all zero.
true iff the parameters designate a subarray of
non-negative length and the weights array contains legitimate values.MathIllegalArgumentException if any of the following are true:
falselength is 0 unless allowEmpty is true.
values - the input array.weights - the weights array.begin - index of the first array element to include.length - the number of elements to include.allowEmpty - if true than allow zero length arrays to pass.
true if the parameters are valid.
NullArgumentException - if either of the arrays are null
MathIllegalArgumentException - if the array indices are not valid,
the weights array contains NaN, infinite or negative elements, or there
are no positive weights.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||