Class StatisticsConfiguration
- java.lang.Object
-
- org.apache.commons.statistics.descriptive.StatisticsConfiguration
-
public final class StatisticsConfiguration extends java.lang.Object
Configuration for computation of statistics.This class is immutable.
- Since:
- 1.1
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
biased
Flag to control if the statistic is biased, or should use a bias correction.private static StatisticsConfiguration
DEFAULT
Default instance.
-
Constructor Summary
Constructors Modifier Constructor Description private
StatisticsConfiguration(boolean biased)
Create an instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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.
-
-
-
Field Detail
-
DEFAULT
private static final StatisticsConfiguration DEFAULT
Default instance.
-
biased
private final boolean biased
Flag to control if the statistic is biased, or should use a bias correction.
-
-
Method Detail
-
withDefaults
public static StatisticsConfiguration withDefaults()
Return an instance using the default options.- 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:
- Parameters:
v
- Value.- Returns:
- an instance
-
isBiased
public boolean isBiased()
Checks if the calculation of the statistic is biased. Iffalse
the calculation should use a bias correction.- Returns:
- true if biased
-
-