AbstractUnivariateStatistic
org.apache.commons.math3.stat.descriptive

Class AbstractUnivariateStatistic

    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      abstract UnivariateStatisticcopy()
      Returns a copy of the statistic with the same internal state.
      doubleevaluate()
      Returns the result of evaluating the statistic over the stored data.
      doubleevaluate(double[] values)
      Returns the result of evaluating the statistic over the input array.
      abstract doubleevaluate(double[] values, int begin, int length)
      Returns the result of evaluating the statistic over the specified entries in the input array.
      double[]getData()
      Get a copy of the stored data array.
      voidsetData(double[] values)
      Set the data array.
      voidsetData(double[] values, int begin, int length)
      Set the data array.
    • Constructor Detail

      • AbstractUnivariateStatistic

        public AbstractUnivariateStatistic()
    • Method Detail

      • 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)
      • 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()
      • 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 UnivariateStatistic
        Specified by:
        evaluate in interface MathArrays.Function
        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

SCaVis 2.2 © jWork.ORG