public class SumOfLogs extends AbstractStorelessUnivariateStatistic implements AggregatableStatistic<SumOfLogs>, Serializable
Uses FastMath.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 |
aggregate(SumOfLogs other)
Aggregates the provided instance into this instance.
|
void |
clear()
Clears the internal state of the Statistic
|
SumOfLogs |
copy()
Returns a copy of the statistic with the same internal state.
|
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, hashCode, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitaggregate, aggregateaccept, incrementAll, incrementAllevaluateandThenpublic SumOfLogs()
public SumOfLogs(SumOfLogs original) throws NullArgumentException
SumOfLogs identical
to the original.original - 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 void aggregate(SumOfLogs other)
This method can be used to combine statistics computed over partitions or subsamples - i.e., the value of this instance after this operation should be the same as if a single statistic would have been applied over the combined dataset.
aggregate in interface AggregatableStatistic<SumOfLogs>other - the instance to aggregate into this instancepublic double evaluate(double[] values,
int begin,
int length)
throws MathIllegalArgumentException
Double.NaN if the designated subarray
is empty.evaluate in interface StorelessUnivariateStatisticevaluate in interface UnivariateStatisticevaluate in interface MathArrays.Functionvalues - 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 AbstractStorelessUnivariateStatisticCopyright © 2016–2020 Hipparchus.org. All rights reserved.