Class Sum
- All Implemented Interfaces:
DoubleConsumer
,DoubleSupplier
,IntSupplier
,LongSupplier
,DoubleStatistic
,StatisticAccumulator<Sum>
,StatisticResult
- The result is zero if no values are added.
- The result is
NaN
if any of the values isNaN
. - The result is
NaN
if the values contain positive and negative infinity. - The result is non-finite if the values contain infinities of the same sign.
Note: In the event of infinite values of the same sign the result will be non-finite.
In this case the returned results may differ (either the same infinity or NaN
) based on
input order if the sum of the finite-only values can overflow to an opposite signed infinity.
This class is designed to work with (though does not require) streams.
This instance is not thread safe.
If multiple threads access an instance of this class concurrently,
and at least one of the threads invokes the accept
or
combine
method, it must be synchronized externally.
However, it is safe to use accept
and combine
as accumulator
and combiner
functions of
Collector
on a parallel stream,
because the parallel instance of Stream.collect()
provides the necessary partitioning, isolation, and merging of results for
safe and efficient parallel execution.
- Since:
- 1.1
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final org.apache.commons.numbers.core.Sum
Sum
used to compute the sum. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(double value) Updates the state of the statistic to reflect the addition ofvalue
.Combines the state of theother
statistic into this one.static Sum
create()
Creates an instance.double
Gets the sum of all input values.static Sum
of
(double... values) Returns an instance populated using the inputvalues
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.function.DoubleConsumer
andThen
Methods inherited from interface org.apache.commons.statistics.descriptive.StatisticResult
getAsBigInteger, getAsInt, getAsLong
-
Field Details
-
delegate
private final org.apache.commons.numbers.core.Sum delegateSum
used to compute the sum.
-
-
Constructor Details
-
Sum
private Sum()Create an instance. -
Sum
Sum(org.apache.commons.numbers.core.Sum sum) Create an instance using the specifiedsum
.- Parameters:
sum
- Sum.
-
-
Method Details
-
create
Creates an instance.The initial result is zero.
- Returns:
Sum
instance.
-
of
Returns an instance populated using the inputvalues
.The result is
NaN
if any of the values isNaN
or the sum at any point is aNaN
.When the input is an empty array, the result is zero.
- Parameters:
values
- Values.- Returns:
Sum
instance.
-
accept
public void accept(double value) Updates the state of the statistic to reflect the addition ofvalue
.- Specified by:
accept
in interfaceDoubleConsumer
- Parameters:
value
- Value.
-
getAsDouble
public double getAsDouble()Gets the sum of all input values.When no values have been added, the result is zero.
- Specified by:
getAsDouble
in interfaceDoubleSupplier
- Returns:
- sum of all values.
-
combine
Description copied from interface:StatisticAccumulator
Combines the state of theother
statistic into this one.- Specified by:
combine
in interfaceStatisticAccumulator<Sum>
- Parameters:
other
- Another statistic to be combined.- Returns:
this
instance after combiningother
.
-