Enum Statistic.PValueMode

java.lang.Object
java.lang.Enum<Statistic.PValueMode>
org.bzdev.math.stats.Statistic.PValueMode
All Implemented Interfaces:
Serializable, Comparable<Statistic.PValueMode>
Enclosing class:
Statistic

public static enum Statistic.PValueMode extends Enum<Statistic.PValueMode>
Mode for P-value computations.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Indicates the the probability of the statistic being smaller than (or equal to) the value for this statistic should be computed.
    Indicates that the p value computation should use the mode NEGATIVE_SIDE if the statistic is smaller than the value returned by the method Statistic.optimalValue() and otherwise use the mode POSITIVE_SIDE.
    Indicates that the probability of the statistic being larger than (or equal to) the value for this statistic should be computed.
    Indicates that the probability of the statistic being more extreme (or equal to) the value for this statistic should be computed.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    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
  • Enum Constant Details

    • POSITIVE_SIDE

      public static final Statistic.PValueMode POSITIVE_SIDE
      Indicates that the probability of the statistic being larger than (or equal to) the value for this statistic should be computed. This is generally the correct choice when a statistic's probability distribution's domain has a minimum value of 0.
    • NEGATIVE_SIDE

      public static final Statistic.PValueMode NEGATIVE_SIDE
      Indicates the the probability of the statistic being smaller than (or equal to) the value for this statistic should be computed.
    • TWO_SIDED

      public static final Statistic.PValueMode TWO_SIDED
      Indicates that the probability of the statistic being more extreme (or equal to) the value for this statistic should be computed. If a statistic is not symmetric, this option will result in an error.
    • ONE_SIDED

      public static final Statistic.PValueMode ONE_SIDED
      Indicates that the p value computation should use the mode NEGATIVE_SIDE if the statistic is smaller than the value returned by the method Statistic.optimalValue() and otherwise use the mode POSITIVE_SIDE. This mode is used primarily in cases where the domain minimum for the probability distribution functions is the value returned by Statistic.optimalValue(), in which case it acts like a synonym for POSITIVE_SIDE.
  • Method Details

    • values

      public static Statistic.PValueMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Statistic.PValueMode valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null