public class SumOfLogs extends AbstractStorelessUnivariateStatistic implements Serializable
Uses MathLib.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 and Description |
|---|
SumOfLogs()
Create a SumOfLogs instance
|
SumOfLogs(SumOfLogs original)
Copy constructor, creates a new
SumOfLogs identical
to the original |
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Clears the internal state of the Statistic
|
SumOfLogs |
copy()
Returns a copy of the statistic with the same internal state.
|
static void |
copy(SumOfLogs source,
SumOfLogs dest)
Copies source to dest.
|
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.
|
equals, evaluate, hashCode, incrementAll, incrementAllevaluate, getData, getDataRef, setData, setData, test, test, test, testpublic SumOfLogs()
public SumOfLogs(SumOfLogs original)
SumOfLogs identical
to the originaloriginal - the SumOfLogs instance to copyNullArgumentException - if original is nullpublic 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 AbstractStorelessUnivariateStatisticpublic double evaluate(double[] values,
int begin,
int length)
Double.NaN if the designated subarray
is empty.
Throws MathIllegalArgumentException if the array is null.
See SumOfLogs.
evaluate in interface UnivariateStatisticevaluate in interface MathArrays.Functionevaluate in class AbstractStorelessUnivariateStatisticvalues - the input arraybegin - index of the first array element to includelength - the number of elements to includeMathIllegalArgumentException - if the array is null or the array index
parameters are not validUnivariateStatistic.evaluate(double[], int, int)public SumOfLogs copy()
copy in interface StorelessUnivariateStatisticcopy in interface UnivariateStatisticcopy in class AbstractStorelessUnivariateStatisticpublic static void copy(SumOfLogs source, SumOfLogs dest)
Neither source nor dest can be null.
source - SumOfLogs to copydest - SumOfLogs to copy toNullArgumentException - if either source or dest is nullCopyright © 2023 CNES. All rights reserved.