Serializable
, DoubleConsumer
, AggregatableStatistic<Sum>
, StorelessUnivariateStatistic
, UnivariateStatistic
, WeightedEvaluation
, MathArrays.Function
public class Sum extends AbstractStorelessUnivariateStatistic implements AggregatableStatistic<Sum>, WeightedEvaluation, Serializable
If there are no values in the dataset, then 0 is returned.
If 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 | Description |
---|---|
Sum() |
Create a Sum instance.
|
Sum(Sum original) |
Copy constructor, creates a new
Sum identical
to the original . |
Modifier and Type | Method | Description |
---|---|---|
void |
aggregate(Sum other) |
Aggregates the provided instance into this instance.
|
void |
clear() |
Clears the internal state of the Statistic
|
Sum |
copy() |
Returns a copy of the statistic with the same internal state.
|
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 0 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 0 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, toString
aggregate, aggregate
andThen
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
accept, incrementAll, incrementAll
evaluate
evaluate
public Sum()
public Sum(Sum original) throws NullArgumentException
Sum
identical
to the original
.original
- the Sum
instance to copyNullArgumentException
- if original is nullpublic void increment(double d)
increment
in interface StorelessUnivariateStatistic
increment
in class AbstractStorelessUnivariateStatistic
d
- the new value.public double getResult()
getResult
in interface StorelessUnivariateStatistic
getResult
in class AbstractStorelessUnivariateStatistic
Double.NaN
if it
has been cleared or just instantiated.public long getN()
getN
in interface StorelessUnivariateStatistic
public void clear()
clear
in interface StorelessUnivariateStatistic
clear
in class AbstractStorelessUnivariateStatistic
public void aggregate(Sum 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<Sum>
other
- the instance to aggregate into this instancepublic double evaluate(double[] values, int begin, int length) throws MathIllegalArgumentException
evaluate
in interface MathArrays.Function
evaluate
in interface StorelessUnivariateStatistic
evaluate
in interface UnivariateStatistic
values
- 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 double evaluate(double[] values, double[] weights, int begin, int length) throws MathIllegalArgumentException
Throws MathIllegalArgumentException
if any of the following are true:
Uses the formula,
weighted sum = Σ(values[i] * weights[i])
evaluate
in interface WeightedEvaluation
values
- the input arrayweights
- the weights arraybegin
- index of the first array element to includelength
- the number of elements to includeMathIllegalArgumentException
- if the parameters are not validpublic Sum copy()
copy
in interface StorelessUnivariateStatistic
copy
in interface UnivariateStatistic
copy
in class AbstractStorelessUnivariateStatistic
Copyright © 2016–2018 Hipparchus.org. All rights reserved.