Class Sum
java.lang.Object
org.hipparchus.stat.descriptive.AbstractStorelessUnivariateStatistic
org.hipparchus.stat.descriptive.summary.Sum
- All Implemented Interfaces:
Serializable
,DoubleConsumer
,AggregatableStatistic<Sum>
,StorelessUnivariateStatistic
,UnivariateStatistic
,WeightedEvaluation
,MathArrays.Function
public class Sum
extends AbstractStorelessUnivariateStatistic
implements AggregatableStatistic<Sum>, WeightedEvaluation, Serializable
Returns the sum of the available values.
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.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Aggregates the provided instance into this instance.void
clear()
Clears the internal state of the Statisticcopy()
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
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.hipparchus.stat.descriptive.AbstractStorelessUnivariateStatistic
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hipparchus.stat.descriptive.AggregatableStatistic
aggregate, aggregate
Methods inherited from interface java.util.function.DoubleConsumer
andThen
Methods inherited from interface org.hipparchus.stat.descriptive.StorelessUnivariateStatistic
accept, incrementAll, incrementAll
Methods inherited from interface org.hipparchus.stat.descriptive.UnivariateStatistic
evaluate
Methods inherited from interface org.hipparchus.stat.descriptive.WeightedEvaluation
evaluate
-
Constructor Details
-
Sum
public Sum()Create a Sum instance. -
Sum
Copy constructor, creates a newSum
identical to theoriginal
.- Parameters:
original
- theSum
instance to copy- Throws:
NullArgumentException
- if original is null
-
-
Method Details
-
increment
public void increment(double d) Updates the internal state of the statistic to reflect the addition of the new value.- Specified by:
increment
in interfaceStorelessUnivariateStatistic
- Specified by:
increment
in classAbstractStorelessUnivariateStatistic
- Parameters:
d
- the new value.
-
getResult
public double getResult()Returns the current value of the Statistic.- Specified by:
getResult
in interfaceStorelessUnivariateStatistic
- Specified by:
getResult
in classAbstractStorelessUnivariateStatistic
- Returns:
- value of the statistic,
Double.NaN
if it has been cleared or just instantiated.
-
getN
public long getN()Returns the number of values that have been added.- Specified by:
getN
in interfaceStorelessUnivariateStatistic
- Returns:
- the number of values.
-
clear
public void clear()Clears the internal state of the Statistic- Specified by:
clear
in interfaceStorelessUnivariateStatistic
- Specified by:
clear
in classAbstractStorelessUnivariateStatistic
-
aggregate
Aggregates the provided instance into this instance.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.
- Specified by:
aggregate
in interfaceAggregatableStatistic<Sum>
- Parameters:
other
- the instance to aggregate into this instance
-
evaluate
The sum of the entries in the specified portion of the input array, or 0 if the designated subarray is empty.- Specified by:
evaluate
in interfaceMathArrays.Function
- Specified by:
evaluate
in interfaceStorelessUnivariateStatistic
- Specified by:
evaluate
in interfaceUnivariateStatistic
- Parameters:
values
- the input arraybegin
- index of the first array element to includelength
- the number of elements to include- Returns:
- the sum of the values or 0 if length = 0
- Throws:
MathIllegalArgumentException
- if the array is null or the array index parameters are not valid- See Also:
-
evaluate
public double evaluate(double[] values, double[] weights, int begin, int length) throws MathIllegalArgumentException The weighted sum of the entries in the specified portion of the input array, or 0 if the designated subarray is empty.Throws
MathIllegalArgumentException
if any of the following are true:- the values array is null
- the weights array is null
- the weights array does not have the same length as the values array
- the weights array contains one or more infinite values
- the weights array contains one or more NaN values
- the weights array contains negative values
- the start and length arguments do not determine a valid array
Uses the formula,
weighted sum = Σ(values[i] * weights[i])
- Specified by:
evaluate
in interfaceWeightedEvaluation
- Parameters:
values
- the input arrayweights
- the weights arraybegin
- index of the first array element to includelength
- the number of elements to include- Returns:
- the sum of the values or 0 if length = 0
- Throws:
MathIllegalArgumentException
- if the parameters are not valid
-
copy
Returns a copy of the statistic with the same internal state.- Specified by:
copy
in interfaceStorelessUnivariateStatistic
- Specified by:
copy
in interfaceUnivariateStatistic
- Specified by:
copy
in classAbstractStorelessUnivariateStatistic
- Returns:
- a copy of the statistic
-