Package org.apache.commons.statistics.descriptive

Class StatisticsConfiguration

java.lang.Object

org.apache.commons.statistics.descriptive.StatisticsConfiguration

public final class StatisticsConfiguration
extends Object

Configuration for computation of statistics.

This class is immutable.

Since:

1.1

Method Summary

Modifier and Type	Method	Description
boolean	isBiased()	Checks if the calculation of the statistic is biased.
StatisticsConfiguration	withBiased(boolean v)	Return an instance with the configured biased option.
static StatisticsConfiguration	withDefaults()	Return an instance using the default options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withDefaults

public static StatisticsConfiguration withDefaults()

Return an instance using the default options.

• Biased = false

Returns:

default instance

withBiased

public StatisticsConfiguration withBiased(boolean v)

Return an instance with the configured biased option.

The correction of bias in a statistic is implementation dependent. If set to true then bias correction will be disabled.

This option is used by:

• StandardDeviation
• Variance
• Skewness
• Kurtosis

Parameters:

v - Value.

Returns:

an instance

isBiased

public boolean isBiased()

Checks if the calculation of the statistic is biased. If false the calculation should use a bias correction.

Returns:

true if biased