public abstract class AbstractUnivariateStatistic extends java.lang.Object implements UnivariateStatistic
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 and Description |
---|
AbstractUnivariateStatistic() |
Modifier and Type | Method and Description |
---|---|
abstract UnivariateStatistic |
copy()
Returns a copy of the statistic with the same internal state.
|
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.
|
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,
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. |
public double evaluate(double[] values)
evaluate
in interface UnivariateStatistic
values
- input arraypublic abstract double evaluate(double[] values, int begin, int length)
evaluate
in interface UnivariateStatistic
values
- the input arraybegin
- the index of the first element to includelength
- the number of elements to includepublic abstract UnivariateStatistic copy()
copy
in interface UnivariateStatistic
protected boolean test(double[] values, int begin, int length)
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 lengthIllegalArgumentException
if the array is null or
or the indices are invalidfalse
length
is 0.
values
- the input arraybegin
- index of the first array element to includelength
- the number of elements to includejava.lang.IllegalArgumentException
- if the indices are invalid or the array is nullprotected boolean test(double[] values, double[] weights, int begin, int length)
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:
false
length
is 0.
values
- the input arrayweights
- the weights arraybegin
- index of the first array element to includelength
- the number of elements to includejava.lang.IllegalArgumentException
- if the indices are invalid or the array is null