Class Product
- java.lang.Object
-
- org.apache.commons.statistics.descriptive.Product
-
- All Implemented Interfaces:
DoubleConsumer,DoubleSupplier,IntSupplier,LongSupplier,DoubleStatistic,StatisticAccumulator<Product>,StatisticResult
public final class Product extends Object implements DoubleStatistic, StatisticAccumulator<Product>
Returns the product of the available values.- The result is one if no values are observed.
- The result is
NaNif 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
acceptorcombinemethod, it must be synchronized externally.However, it is safe to use
acceptandcombineasaccumulatorandcombinerfunctions ofCollectoron a parallel stream, because the parallel instance ofStream.collect()provides the necessary partitioning, isolation, and merging of results for safe and efficient parallel execution.- Since:
- 1.1
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(double value)Updates the state of the statistic to reflect the addition ofvalue.Productcombine(Product other)Combines the state of theotherstatistic into this one.static Productcreate()Creates an instance.doublegetAsDouble()Gets the product of all input values.static Productof(double... values)Returns an instance populated using the inputvalues.static Productof(int... values)Returns an instance populated using the inputvalues.static Productof(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
-
-
-
-
Method Detail
-
create
public static Product create()
Creates an instance.The initial result is one.
- Returns:
Productinstance.
-
of
public static Product of(double... values)
Returns an instance populated using the inputvalues.The result is
NaNif any of the values isNaNor the product at any point is aNaN.When the input is an empty array, the result is one.
- Parameters:
values- Values.- Returns:
Productinstance.
-
of
public static Product of(int... values)
Returns an instance populated using the inputvalues.When the input is an empty array, the result is one.
- Parameters:
values- Values.- Returns:
Productinstance.
-
of
public static Product of(long... values)
Returns an instance populated using the inputvalues.When the input is an empty array, the result is one.
- Parameters:
values- Values.- Returns:
Productinstance.
-
accept
public void accept(double value)
Updates the state of the statistic to reflect the addition ofvalue.- Specified by:
acceptin 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:
getAsDoublein interfaceDoubleSupplier- Returns:
- product of all values.
-
combine
public Product combine(Product other)
Description copied from interface:StatisticAccumulatorCombines the state of theotherstatistic into this one.- Specified by:
combinein interfaceStatisticAccumulator<Product>- Parameters:
other- Another statistic to be combined.- Returns:
thisinstance after combiningother.
-
-