Enum Statistic

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Statistic>

    public enum Statistic
    extends java.lang.Enum<Statistic>
    A statistic that can be computed on univariate data, for example a stream of double values.

    Statistic is an enum representing the statistics that can be computed by implementations in the org.apache.commons.statistics.descriptive package.

    Note

    Implementations may provide additional parameters to control the computation of the statistic, for example to compute the population (biased) or sample (unbiased) variance.

    Since:
    1.1
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Statistic()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Statistic valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Statistic[] 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
    • Enum Constant Detail

      • MIN

        public static final Statistic MIN
        Minimum.
      • MAX

        public static final Statistic MAX
        Maximum.
      • MEAN

        public static final Statistic MEAN
        Mean, or average.
      • STANDARD_DEVIATION

        public static final Statistic STANDARD_DEVIATION
        Standard deviation.
      • VARIANCE

        public static final Statistic VARIANCE
        Variance.
      • SKEWNESS

        public static final Statistic SKEWNESS
        Skewness.
      • KURTOSIS

        public static final Statistic KURTOSIS
        Kurtosis.
      • PRODUCT

        public static final Statistic PRODUCT
        Product.
      • SUM

        public static final Statistic SUM
        Sum.
      • SUM_OF_LOGS

        public static final Statistic SUM_OF_LOGS
        Sum of the natural logarithm of values.
      • SUM_OF_SQUARES

        public static final Statistic SUM_OF_SQUARES
        Sum of the squared values.
      • GEOMETRIC_MEAN

        public static final Statistic GEOMETRIC_MEAN
        Geometric mean.
    • Constructor Detail

      • Statistic

        private Statistic()
    • Method Detail

      • values

        public static Statistic[] 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 (Statistic c : Statistic.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Statistic 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