Class PSquarePercentile

    • Constructor Detail

      • PSquarePercentile

        public PSquarePercentile​(double p)
        Constructs a PSquarePercentile with the specific percentile value.
        Parameters:
        p - the percentile
        Throws:
        OutOfRangeException - if p is not greater than 0 and less than or equal to 100
    • Method Detail

      • equals

        public boolean equals​(java.lang.Object o)
        Returns true iff o is a PSquarePercentile returning the same values as this for getResult() and getN() and also having equal markers
        Overrides:
        equals in class AbstractStorelessUnivariateStatistic
        Parameters:
        o - object to compare
        Returns:
        true if o is a PSquarePercentile with equivalent internal state
      • increment

        public void increment​(double observation)
        Updates the internal state of the statistic to reflect the addition of the new value.The internal state updated due to the new value in this context is basically of the marker positions and computation of the approximate quantile.
        Specified by:
        increment in interface StorelessUnivariateStatistic
        Specified by:
        increment in class AbstractStorelessUnivariateStatistic
        Parameters:
        observation - the observation currently being added.
      • toString

        public java.lang.String toString()
        Returns a string containing the last observation, the current estimate of the quantile and all markers.
        Overrides:
        toString in class java.lang.Object
        Returns:
        string representation of state data
      • getN

        public long getN()
        Returns the number of values that have been added.
        Specified by:
        getN in interface StorelessUnivariateStatistic
        Returns:
        the number of values.
      • quantile

        public double quantile()
        Returns the quantile estimated by this statistic in the range [0.0-1.0]
        Returns:
        quantile estimated by getResult()
      • newMarkers

        public static PSquarePercentile.PSquareMarkers newMarkers​(java.util.List<java.lang.Double> initialFive,
                                                                  double p)
        A creation method to build Markers
        Parameters:
        initialFive - list of initial five elements
        p - the quantile desired
        Returns:
        an instance of PSquareMarkers