|
||||||||||
| 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 |
|
Sum(Sum original)
Copy constructor, creates a new Sum identical
to the original |
|
| Method Summary | |
|---|---|
void |
clear()
Clears the internal state of the Statistic |
Sum |
copy()
Returns a copy of the statistic with the same internal state. |
static void |
copy(Sum source,
Sum dest)
Copies source to dest. |
double |
evaluate(double[] values,
double[] weights)
The weighted sum of the entries in the the input array. |
double |
evaluate(double[] values,
double[] weights,
int begin,
int length)
The weighted sum of the entries in the specified portion of the input array, or Double.NaN if the designated subarray
is empty. |
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 |
|---|
evaluate, getData, getDataRef, setData, setData, test, test |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Sum()
public Sum(Sum original)
Sum identical
to the original
original - the Sum instance to copy| Method Detail |
|---|
public void increment(double d)
increment in interface StorelessUnivariateStatisticincrement in class AbstractStorelessUnivariateStatisticd - the new value.public double getResult()
getResult in interface StorelessUnivariateStatisticgetResult in class AbstractStorelessUnivariateStatisticDouble.NaN if it
has been cleared or just instantiated.public long getN()
getN in interface StorelessUnivariateStatisticpublic void clear()
clear in interface StorelessUnivariateStatisticclear in class AbstractStorelessUnivariateStatistic
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 UnivariateStatisticevaluate in class AbstractStorelessUnivariateStatisticvalues - 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)
public double evaluate(double[] values,
double[] weights,
int begin,
int length)
Double.NaN if the designated subarray
is empty.
Throws IllegalArgumentException if any of the following are true:
Uses the formula,
weighted sum = Σ(values[i] * weights[i])
values - the input arrayweights - the weights arraybegin - index of the first array element to includelength - the number of elements to include
IllegalArgumentException - if the parameters are not valid
public double evaluate(double[] values,
double[] weights)
Throws IllegalArgumentException if any of the following are true:
Uses the formula,
weighted sum = Σ(values[i] * weights[i])
values - the input arrayweights - the weights array
IllegalArgumentException - if the parameters are not validpublic Sum copy()
copy in interface StorelessUnivariateStatisticcopy in interface UnivariateStatisticcopy in class AbstractStorelessUnivariateStatistic
public static void copy(Sum source,
Sum dest)
Neither source nor dest can be null.
source - Sum to copydest - Sum to copy to
NullPointerException - if either source or dest is null
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||