Package org.apache.commons.statistics.descriptive

Class IntStatistics.Builder

  • Enclosing class:
    IntStatistics
    public static final class IntStatistics.Builder
extends java.lang.Object
    A builder for IntStatistics.

    • Field Detail

      • NO_VALUES

        private static final int[] NO_VALUES
        An empty double array.

      • min

        private java.util.function.Function<int[],​IntMin> min
        The IntMin constructor.

      • max

        private java.util.function.Function<int[],​IntMax> max
        The IntMax constructor.

      • moment

        private java.util.function.Function<int[],​FirstMoment> moment
        The moment constructor. May return any instance of FirstMoment.

      • sum

        private java.util.function.Function<int[],​IntSum> sum
        The IntSum constructor.

      • product

        private java.util.function.Function<int[],​Product> product
        The Product constructor.

      • sumOfLogs

        private java.util.function.Function<int[],​SumOfLogs> sumOfLogs
        The SumOfLogs constructor.

      • momentOrder

        private int momentOrder
        The order of the moment. It corresponds to the power computed by the FirstMoment instance constructed by moment. This should only be increased from the default of zero (corresponding to no moment computation).

    • Constructor Detail

      • Builder

        Builder()
        Create an instance.

    • Method Detail

      • add

        IntStatistics.Builder add​(Statistic statistic)
        Add the statistic to the statistics to compute.
        Parameters:
        statistic - Statistic to compute.
        Returns:
        this instance

      • createMoment

        private void createMoment​(int order)
        Creates the moment constructor for the specified order, e.g. order=3 is sum of cubed deviations.
        Parameters:
        order - Order.

      • setConfiguration

        public IntStatistics.Builder setConfiguration​(StatisticsConfiguration v)
        Sets the statistics configuration options for computation of statistics.
        Parameters:
        v - Value.
        Returns:
        the builder
        Throws:
        java.lang.NullPointerException - if the value is null

      • build

        public IntStatistics build()
        Builds a IntStatistics instance.
        Returns:
        IntStatistics instance.

      • build

        public IntStatistics build​(int... values)
        Builds a IntStatistics instance using the input values.

        Note: IntStatistics computed using accept may be different from this instance.

        Parameters:
        values - Values.
        Returns:
        IntStatistics instance.

      • create

        private static <T> T create​(java.util.function.Function<int[],​T> constructor,
                            int[] values)
        Creates the object from the values.
        Type Parameters:
        T - object type
        Parameters:
        constructor - Constructor.
        values - Values
        Returns:
        the instance