org.apache.commons.math3.stat.descriptive.SummaryStatistics that
is safe to use in a multithreaded environment. Multiple threads can safely
operate on a single instance without causing runtime exceptions due to race
conditions. In effect, this implementation makes modification and access
methods atomic operations for a single instance. That is to say, as one
thread is computing a statistic from the instance, no other thread can modify
the instance nor compute another statistic.
| Modifier and Type | Field and Description |
|---|---|
| private static final long | serialVersionUID
Hides org. |
| Access | Constructor and Description |
|---|---|
| public | |
| public | SynchronizedSummaryStatistics(SynchronizedSummaryStatistics
the original)SynchronizedSummaryStatistics instance to copyA copy constructor. |
| Modifier and Type | Method and Description |
|---|---|
| public synchronized void | addValue(double
the value to add value)Overrides org. Add a value to the data |
| public synchronized void | clear()
Overrides org. Resets all statistics and storage |
| public synchronized SynchronizedSummaryStatistics | Returns: a copy of thisOverrides org. Returns a copy of this SynchronizedSummaryStatistics instance with the same internal state. |
| public static void | copy(SynchronizedSummaryStatistics
SynchronizedSummaryStatistics to copy source, SynchronizedSummaryStatistics SynchronizedSummaryStatistics to copy to dest)Copies source to dest. |
| public synchronized boolean | equals(Object
the object to test equality against. object)Overrides org. Returns true iff |
| public synchronized StorelessUnivariateStatistic | getGeoMeanImpl()
Overrides org. Returns the currently configured geometric mean implementation |
| public synchronized double | getGeometricMean()
Overrides org. Returns the geometric mean of the values that have been added. |
| public synchronized double | getMax()
Overrides org. Implements org. Returns the maximum of the values that have been added. |
| public synchronized StorelessUnivariateStatistic | getMaxImpl()
Overrides org. Returns the currently configured maximum implementation |
| public synchronized double | getMean()
Overrides org. Implements org. Returns the mean of the values that have been added. |
| public synchronized StorelessUnivariateStatistic | getMeanImpl()
Overrides org. Returns the currently configured mean implementation |
| public synchronized double | getMin()
Overrides org. Implements org. Returns the minimum of the values that have been added. |
| public synchronized StorelessUnivariateStatistic | getMinImpl()
Overrides org. Returns the currently configured minimum implementation |
| public synchronized long | getN()
Overrides org. Implements org. Returns the number of available values |
| public synchronized double | getPopulationVariance()
Overrides org. Returns the population variance of the values that have been added. |
| public synchronized double | getQuadraticMean()
Overrides org. Returns the quadratic mean, a.k.a. root-mean-square of the available values |
| public synchronized double | getStandardDeviation()
Overrides org. Implements org. Returns the standard deviation of the values that have been added. |
| public synchronized double | getSum()
Overrides org. Implements org. Returns the sum of the values that have been added |
| public synchronized StorelessUnivariateStatistic | getSumImpl()
Overrides org. Returns the currently configured Sum implementation |
| public synchronized StorelessUnivariateStatistic | getSumLogImpl()
Overrides org. Returns the currently configured sum of logs implementation |
| public synchronized StatisticalSummary | getSummary()
Overrides org. Return a |
| public synchronized double | getSumsq()
Overrides org. Returns the sum of the squares of the values that have been added. |
| public synchronized StorelessUnivariateStatistic | getSumsqImpl()
Overrides org. Returns the currently configured sum of squares implementation |
| public synchronized double | getVariance()
Overrides org. Implements org. Returns the (sample) variance of the available values. |
| public synchronized StorelessUnivariateStatistic | getVarianceImpl()
Overrides org. Returns the currently configured variance implementation |
| public synchronized int | hashCode()
Overrides org. Returns hash code based on values of statistics |
| public synchronized void | setGeoMeanImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the geometric mean geoMeanImpl)Overrides org. Sets the implementation for the geometric mean. |
| public synchronized void | setMaxImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the maximum maxImpl)Overrides org. Sets the implementation for the maximum. |
| public synchronized void | setMeanImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the mean meanImpl)Overrides org. Sets the implementation for the mean. |
| public synchronized void | setMinImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the minimum minImpl)Overrides org. Sets the implementation for the minimum. |
| public synchronized void | setSumImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the Sum sumImpl)Overrides org. Sets the implementation for the Sum. |
| public synchronized void | setSumLogImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the log sum sumLogImpl)Overrides org. Sets the implementation for the sum of logs. |
| public synchronized void | setSumsqImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the sum of squares sumsqImpl)Overrides org. Sets the implementation for the sum of squares. |
| public synchronized void | setVarianceImpl(StorelessUnivariateStatistic
the StorelessUnivariateStatistic instance to use for
computing the variance varianceImpl)Overrides org. Sets the implementation for the variance. |
| public synchronized String | toString()
Overrides org. Generates a text report displaying summary statistics from values that have been added. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides org. Serialization UID | |
| SynchronizedSummaryStatistics | back to summary |
|---|---|
| public SynchronizedSummaryStatistics() Construct a SynchronizedSummaryStatistics instance | |
| SynchronizedSummaryStatistics | back to summary |
|---|---|
| public SynchronizedSummaryStatistics(SynchronizedSummaryStatistics original) throws NullArgumentException A copy constructor. Creates a deep-copy of the
| |
| addValue | back to summary |
|---|---|
| public synchronized void addValue(double value) Overrides org. Doc from org. Add a value to the data
| |
| clear | back to summary |
|---|---|
| public synchronized void clear() Overrides org. Doc from org. Resets all statistics and storage
| |
| copy | back to summary |
|---|---|
| public synchronized SynchronizedSummaryStatistics copy() Overrides org. Returns a copy of this SynchronizedSummaryStatistics instance with the same internal state.
| |
| copy | back to summary |
|---|---|
| public static void copy(SynchronizedSummaryStatistics source, SynchronizedSummaryStatistics dest) throws NullArgumentException Copies source to dest. Neither source nor dest can be null. Acquires synchronization lock on source, then dest before copying.
| |
| equals | back to summary |
|---|---|
| public synchronized boolean equals(Object object) Overrides org. Doc from org. Returns true iff | |
| getGeoMeanImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getGeoMeanImpl() Overrides org. Doc from org. Returns the currently configured geometric mean implementation
| |
| getGeometricMean | back to summary |
|---|---|
| public synchronized double getGeometricMean() Overrides org. Doc from org. Returns the geometric mean of the values that have been added. Double.NaN is returned if no values have been added.
| |
| getMax | back to summary |
|---|---|
| public synchronized double getMax() Overrides org. Implements org. Doc from org. Returns the maximum of the values that have been added. Double.NaN is returned if no values have been added.
| |
| getMaxImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getMaxImpl() Overrides org. Doc from org. Returns the currently configured maximum implementation
| |
| getMean | back to summary |
|---|---|
| public synchronized double getMean() Overrides org. Implements org. Doc from org. Returns the mean of the values that have been added. Double.NaN is returned if no values have been added.
| |
| getMeanImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getMeanImpl() Overrides org. Doc from org. Returns the currently configured mean implementation
| |
| getMin | back to summary |
|---|---|
| public synchronized double getMin() Overrides org. Implements org. Doc from org. Returns the minimum of the values that have been added. Double.NaN is returned if no values have been added.
| |
| getMinImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getMinImpl() Overrides org. Doc from org. Returns the currently configured minimum implementation
| |
| getN | back to summary |
|---|---|
| public synchronized long getN() Overrides org. Implements org. Doc from org. Returns the number of available values
| |
| getPopulationVariance | back to summary |
|---|---|
| public synchronized double getPopulationVariance() Overrides org. Doc from org. Returns the population variance of the values that have been added. Double.NaN is returned if no values have been added.
| |
| getQuadraticMean | back to summary |
|---|---|
| public synchronized double getQuadraticMean() Overrides org. Doc from org. Returns the quadratic mean, a.k.a. root-mean-square of the available values
| |
| getStandardDeviation | back to summary |
|---|---|
| public synchronized double getStandardDeviation() Overrides org. Implements org. Doc from org. Returns the standard deviation of the values that have been added. Double.NaN is returned if no values have been added.
| |
| getSum | back to summary |
|---|---|
| public synchronized double getSum() Overrides org. Implements org. Doc from org. Returns the sum of the values that have been added
| |
| getSumImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getSumImpl() Overrides org. Doc from org. Returns the currently configured Sum implementation
| |
| getSumLogImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getSumLogImpl() Overrides org. Doc from org. Returns the currently configured sum of logs implementation
| |
| getSummary | back to summary |
|---|---|
| public synchronized StatisticalSummary getSummary() Overrides org. Doc from org. Return a
| |
| getSumsq | back to summary |
|---|---|
| public synchronized double getSumsq() Overrides org. Doc from org. Returns the sum of the squares of the values that have been added. Double.NaN is returned if no values have been added.
| |
| getSumsqImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getSumsqImpl() Overrides org. Doc from org. Returns the currently configured sum of squares implementation
| |
| getVariance | back to summary |
|---|---|
| public synchronized double getVariance() Overrides org. Implements org. Doc from org. Returns the (sample) variance of the available values. This method returns the bias-corrected sample variance (using Double.NaN is returned if no values have been added.
| |
| getVarianceImpl | back to summary |
|---|---|
| public synchronized StorelessUnivariateStatistic getVarianceImpl() Overrides org. Doc from org. Returns the currently configured variance implementation
| |
| hashCode | back to summary |
|---|---|
| public synchronized int hashCode() Overrides org. Doc from org. Returns hash code based on values of statistics
| |
| setGeoMeanImpl | back to summary |
|---|---|
| public synchronized void setGeoMeanImpl(StorelessUnivariateStatistic geoMeanImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the geometric mean.
This method cannot be activated after data has been added - i.e.,
after
| |
| setMaxImpl | back to summary |
|---|---|
| public synchronized void setMaxImpl(StorelessUnivariateStatistic maxImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the maximum.
This method cannot be activated after data has been added - i.e.,
after
| |
| setMeanImpl | back to summary |
|---|---|
| public synchronized void setMeanImpl(StorelessUnivariateStatistic meanImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the mean.
This method cannot be activated after data has been added - i.e.,
after
| |
| setMinImpl | back to summary |
|---|---|
| public synchronized void setMinImpl(StorelessUnivariateStatistic minImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the minimum.
This method cannot be activated after data has been added - i.e.,
after
| |
| setSumImpl | back to summary |
|---|---|
| public synchronized void setSumImpl(StorelessUnivariateStatistic sumImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the Sum.
This method cannot be activated after data has been added - i.e.,
after
| |
| setSumLogImpl | back to summary |
|---|---|
| public synchronized void setSumLogImpl(StorelessUnivariateStatistic sumLogImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the sum of logs.
This method cannot be activated after data has been added - i.e.,
after
| |
| setSumsqImpl | back to summary |
|---|---|
| public synchronized void setSumsqImpl(StorelessUnivariateStatistic sumsqImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the sum of squares.
This method cannot be activated after data has been added - i.e.,
after
| |
| setVarianceImpl | back to summary |
|---|---|
| public synchronized void setVarianceImpl(StorelessUnivariateStatistic varianceImpl) throws MathIllegalStateException Overrides org. Doc from org. Sets the implementation for the variance.
This method cannot be activated after data has been added - i.e.,
after
| |
| toString | back to summary |
|---|---|
| public synchronized String toString() Overrides org. Doc from org. Generates a text report displaying summary statistics from values that have been added. | |