|
||||||||||
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
org.apache.commons.math.stat.descriptive.summary.Sum
public class Sum
Returns the sum of the available values.
If there are no values in the dataset, or any of the values are
NaN
, then NaN
is 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()
or
clear()
method, it must be synchronized externally.
Constructor Summary | |
---|---|
Sum()
Create a Sum instance |
Method Summary | |
---|---|
void |
clear()
Clears the internal state of the Statistic |
double |
evaluate(double[] values,
int begin,
int length)
The sum of the entries in the specified portion of the input array, or Double.NaN if the designated subarray
is empty. |
long |
getN()
Returns the number of values that have been added. |
double |
getResult()
Returns the current value of the Statistic. |
void |
increment(double d)
Updates the internal state of the statistic to reflect the addition of the new value. |
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic |
---|
equals, evaluate, hashCode, incrementAll, incrementAll |
Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic |
---|
test |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Sum()
Method Detail |
---|
public void increment(double d)
StorelessUnivariateStatistic
increment
in interface StorelessUnivariateStatistic
increment
in class AbstractStorelessUnivariateStatistic
d
- the new value.StorelessUnivariateStatistic.increment(double)
public double getResult()
StorelessUnivariateStatistic
getResult
in interface StorelessUnivariateStatistic
getResult
in class AbstractStorelessUnivariateStatistic
Double.NaN
if it
has been cleared or just instantiated.StorelessUnivariateStatistic.getResult()
public long getN()
StorelessUnivariateStatistic
getN
in interface StorelessUnivariateStatistic
StorelessUnivariateStatistic.getN()
public void clear()
StorelessUnivariateStatistic
clear
in interface StorelessUnivariateStatistic
clear
in class AbstractStorelessUnivariateStatistic
StorelessUnivariateStatistic.clear()
public double evaluate(double[] values, int begin, int length)
Double.NaN
if the designated subarray
is empty.
Throws IllegalArgumentException
if the array is null.
evaluate
in interface UnivariateStatistic
evaluate
in class AbstractStorelessUnivariateStatistic
values
- the input arraybegin
- index of the first array element to includelength
- the number of elements to include
IllegalArgumentException
- if the array is null or the array index
parameters are not validUnivariateStatistic.evaluate(double[], int, int)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |