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

  • Field Details

    • 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.

  • Constructor Details

    • StatisticsConfiguration

      private StatisticsConfiguration(boolean biased)
      Create an instance.
      Parameters:
      biased - Biased option.

  • Method Details

    • 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. If false the calculation should use a bias correction.
      Returns:
      true if biased