|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic
public abstract class AbstractStorelessUnivariateStatistic
Abstract implementation of the StorelessUnivariateStatistic interface.
Provides default evaluate() and incrementAll(double[])
implementations.
Note that these implementations are not synchronized.
| Constructor Summary | |
|---|---|
AbstractStorelessUnivariateStatistic()
|
|
| Method Summary | |
|---|---|
abstract void |
clear()
Clears the internal state of the Statistic |
abstract StorelessUnivariateStatistic |
copy()
Returns a copy of the statistic with the same internal state. |
boolean |
equals(Object object)
Returns true iff object is an
AbstractStorelessUnivariateStatistic returning the same
values as this for getResult() and getN() |
double |
evaluate(double[] values)
This default implementation calls clear(), then invokes
increment(double) in a loop over the the input array, and then uses
getResult() to compute the return value. |
double |
evaluate(double[] values,
int begin,
int length)
This default implementation calls clear(), then invokes
increment(double) in a loop over the specified portion of the input
array, and then uses getResult() to compute the return value. |
abstract double |
getResult()
Returns the current value of the Statistic. |
int |
hashCode()
Returns hash code based on getResult() and getN() |
abstract void |
increment(double d)
Updates the internal state of the statistic to reflect the addition of the new value. |
void |
incrementAll(double[] values)
This default implementation just calls increment(double) in a loop over
the input array. |
void |
incrementAll(double[] values,
int begin,
int length)
This default implementation just calls increment(double) in a loop over
the specified portion of the input array. |
| Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic |
|---|
test, test |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic |
|---|
getN |
| Constructor Detail |
|---|
public AbstractStorelessUnivariateStatistic()
| Method Detail |
|---|
public double evaluate(double[] values)
clear(), then invokes
increment(double) in a loop over the the input array, and then uses
getResult() to compute the return value.
Note that this implementation changes the internal state of the
statistic. Its side effects are the same as invoking clear() and
then incrementAll(double[]).
Implementations may override this method with a more efficient and possibly more accurate implementation that works directly with the input array.
If the array is null, an IllegalArgumentException is thrown.
evaluate in interface UnivariateStatisticevaluate in class AbstractUnivariateStatisticvalues - input array
UnivariateStatistic.evaluate(double[])
public double evaluate(double[] values,
int begin,
int length)
clear(), then invokes
increment(double) in a loop over the specified portion of the input
array, and then uses getResult() to compute the return value.
Note that this implementation changes the internal state of the
statistic. Its side effects are the same as invoking clear() and
then incrementAll(double[], int, int).
Implementations may override this method with a more efficient and possibly more accurate implementation that works directly with the input array.
If the array is null or the index parameters are not valid, an IllegalArgumentException is thrown.
evaluate in interface UnivariateStatisticevaluate in class AbstractUnivariateStatisticvalues - the input arraybegin - the index of the first element to includelength - the number of elements to include
UnivariateStatistic.evaluate(double[], int, int)public abstract StorelessUnivariateStatistic copy()
copy in interface StorelessUnivariateStatisticcopy in interface UnivariateStatisticcopy in class AbstractUnivariateStatisticpublic abstract void clear()
clear in interface StorelessUnivariateStatisticpublic abstract double getResult()
getResult in interface StorelessUnivariateStatisticDouble.NaN if it
has been cleared or just instantiated.public abstract void increment(double d)
increment in interface StorelessUnivariateStatisticd - the new value.public void incrementAll(double[] values)
increment(double) in a loop over
the input array.
Throws IllegalArgumentException if the input values array is null.
incrementAll in interface StorelessUnivariateStatisticvalues - values to add
IllegalArgumentException - if values is nullStorelessUnivariateStatistic.incrementAll(double[])
public void incrementAll(double[] values,
int begin,
int length)
increment(double) in a loop over
the specified portion of the input array.
Throws IllegalArgumentException if the input values array is null.
incrementAll in interface StorelessUnivariateStatisticvalues - array holding values to addbegin - index of the first array element to addlength - number of array elements to add
IllegalArgumentException - if values is nullStorelessUnivariateStatistic.incrementAll(double[], int, int)public boolean equals(Object object)
object is an
AbstractStorelessUnivariateStatistic returning the same
values as this for getResult() and getN()
equals in class Objectobject - object to test equality against.
public int hashCode()
hashCode in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||