Class AbstractUnivariateStatistic

    • Constructor Detail

      • AbstractUnivariateStatistic

        protected AbstractUnivariateStatistic()
        Default constructor.
      • AbstractUnivariateStatistic

        protected AbstractUnivariateStatistic​(AbstractUnivariateStatistic original)
        Copy constructor, creates an identical copy of the original.
        Parameters:
        original - the instance to copy
        Throws:
        NullArgumentException - if original is null
    • Method Detail

      • evaluate

        public abstract double evaluate​(double[] values,
                                        int begin,
                                        int length)
                                 throws MathIllegalArgumentException
        Returns the result of evaluating the statistic over the specified entries in the input array.
        Specified by:
        evaluate in interface MathArrays.Function
        Specified by:
        evaluate in interface UnivariateStatistic
        Parameters:
        values - the input array
        begin - the index of the first element to include
        length - the number of elements to include
        Returns:
        the value of the statistic applied to the included array entries
        Throws:
        MathIllegalArgumentException - if values is null or the indices are invalid
      • setData

        public void setData​(double[] values)
        Set the data array.

        The stored value is a copy of the parameter array, not the array itself.

        Parameters:
        values - data array to store (may be null to remove stored data)
        See Also:
        evaluate()
      • getData

        public double[] getData()
        Get a copy of the stored data array.
        Returns:
        copy of the stored data array (may be null)
      • getDataRef

        protected double[] getDataRef()
        Get a reference to the stored data array.
        Returns:
        reference to the stored data array (may be null)
      • setData

        public void setData​(double[] values,
                            int begin,
                            int length)
                     throws MathIllegalArgumentException
        Set the data array. The input array is copied, not referenced.
        Parameters:
        values - data array to store
        begin - the index of the first element to include
        length - the number of elements to include
        Throws:
        MathIllegalArgumentException - if values is null or the indices are not valid
        See Also:
        evaluate()