Package org.apache.commons.statistics.interval

Enum BinomialConfidenceInterval

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AGRESTI_COULL
      Implements the Agresti-Coull method for creating a binomial proportion confidence interval.
      CLOPPER_PEARSON
      Implements the Clopper-Pearson method for creating a binomial proportion confidence interval.
      JEFFREYS
      Implements the Jeffreys method for creating a binomial proportion confidence interval.
      NORMAL_APPROXIMATION
      Implements the normal approximation method for creating a binomial proportion confidence interval.
      WILSON_SCORE
      Implements the Wilson score method for creating a binomial proportion confidence interval.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) static double clip​(double p)
      Clip the probability to [0, 1].
      (package private) abstract Interval create​(int n, int x, double alpha)
      Create a confidence interval for the true probability of success of an unknown binomial distribution with the given observed number of trials, successes and error rate.
      Interval fromErrorRate​(int numberOfTrials, int numberOfSuccesses, double alpha)
      Create a confidence interval for the true probability of success of an unknown binomial distribution with the given observed number of trials, successes and error rate.
      static BinomialConfidenceInterval valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BinomialConfidenceInterval[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • NORMAL_DISTRIBUTION

        static final NormalDistribution NORMAL_DISTRIBUTION
        The standard normal distribution.

    • Constructor Detail

      • BinomialConfidenceInterval

        private BinomialConfidenceInterval()

    • Method Detail

      • values

        public static BinomialConfidenceInterval[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (BinomialConfidenceInterval c : BinomialConfidenceInterval.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BinomialConfidenceInterval valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromErrorRate

        public Interval fromErrorRate​(int numberOfTrials,
                              int numberOfSuccesses,
                              double alpha)
        Create a confidence interval for the true probability of success of an unknown binomial distribution with the given observed number of trials, successes and error rate.

        The error rate alpha is related to the confidence level that the interval contains the true probability of success as alpha = 1 - confidence, where confidence is the confidence level in [0, 1]. For example a 95% confidence level is an alpha of 0.05.

        Parameters:
        numberOfTrials - Number of trials.
        numberOfSuccesses - Number of successes.
        alpha - Desired error rate that the true probability of success falls outside the returned interval.
        Returns:
        Confidence interval containing the probability of success with error rate alpha
        Throws:
        java.lang.IllegalArgumentException - if numberOfTrials <= 0, if numberOfSuccesses < 0, if numberOfSuccesses > numberOfTrials, or if alpha is not in the open interval (0, 1).

      • create

        abstract Interval create​(int n,
                         int x,
                         double alpha)
        Create a confidence interval for the true probability of success of an unknown binomial distribution with the given observed number of trials, successes and error rate.
        Parameters:
        n - Number of trials.
        x - Number of successes.
        alpha - Desired error rate.
        Returns:
        Confidence interval

      • clip

        static double clip​(double p)
        Clip the probability to [0, 1].
        Parameters:
        p - Probability.
        Returns:
        the probability in [0, 1]