|
|||||||||||
| 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.SumOfLogs
Returns the sum of the natural logs for this collection of values.
Uses Math.log(double) to compute the logs. Therefore,
NaN.Double.POSITIVE_INFINITY, but at least one value is 0, the
result is Double.NEGATIVE_INFINITY.Double.POSITIVE_INFINITY and
Double.NEGATIVE_INFINITY are among the values, the result is
NaN.
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 | |
SumOfLogs()
Create a SumOfLogs instance |
|
| Method Summary | |
void |
clear()
Clears the internal state of the Statistic |
double |
evaluate(double[] values,
int begin,
int length)
Returns the sum of the natural logs 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 SumOfLogs()
| Method Detail |
public void increment(double d)
StorelessUnivariateStatistic
increment in interface StorelessUnivariateStatisticincrement in class AbstractStorelessUnivariateStatisticStorelessUnivariateStatistic.increment(double)public double getResult()
StorelessUnivariateStatistic
getResult in interface StorelessUnivariateStatisticgetResult in class AbstractStorelessUnivariateStatisticStorelessUnivariateStatistic.getResult()public long getN()
StorelessUnivariateStatistic
getN in interface StorelessUnivariateStatisticStorelessUnivariateStatistic.getN()public void clear()
StorelessUnivariateStatistic
clear in interface StorelessUnivariateStatisticclear in class AbstractStorelessUnivariateStatisticStorelessUnivariateStatistic.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.
See SumOfLogs.
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)
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||