Class Product
- All Implemented Interfaces:
DoubleConsumer
,DoubleSupplier
,IntSupplier
,LongSupplier
,DoubleStatistic
,StatisticAccumulator<Product>
,StatisticResult
- The result is one if no values are observed.
- The result is
NaN
if any of the values isNaN
.
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
-
Field Summary
Fields -
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 Product
create()
Creates an instance.double
Gets the product of all input values.static Product
of
(double... values) Returns an instance populated using the inputvalues
.static Product
of
(int... values) Returns an instance populated using the inputvalues
.static Product
of
(long... 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
-
productValue
private double productValueProduct of all values.
-
-
Constructor Details
-
Product
private Product()Create an instance.
-
-
Method Details
-
create
Creates an instance.The initial result is one.
- Returns:
Product
instance.
-
of
Returns an instance populated using the inputvalues
.The result is
NaN
if any of the values isNaN
or the product at any point is aNaN
.When the input is an empty array, the result is one.
- Parameters:
values
- Values.- Returns:
Product
instance.
-
of
Returns an instance populated using the inputvalues
.When the input is an empty array, the result is one.
- Parameters:
values
- Values.- Returns:
Product
instance.
-
of
Returns an instance populated using the inputvalues
.When the input is an empty array, the result is one.
- Parameters:
values
- Values.- Returns:
Product
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 product of all input values.When no values have been added, the result is one.
- Specified by:
getAsDouble
in interfaceDoubleSupplier
- Returns:
- product of all values.
-
combine
Description copied from interface:StatisticAccumulator
Combines the state of theother
statistic into this one.- Specified by:
combine
in interfaceStatisticAccumulator<Product>
- Parameters:
other
- Another statistic to be combined.- Returns:
this
instance after combiningother
.
-