Class Max

  • All Implemented Interfaces:
    java.io.Serializable, StorelessUnivariateStatistic, UnivariateStatistic

    public class Max
    extends AbstractStorelessUnivariateStatistic
    implements java.io.Serializable
    Returns the maximum of the available values.

    • The result is NaN iff all values are NaN (i.e. NaN values have no impact on the value of the statistic).
    • If any of the values equals Double.POSITIVE_INFINITY, the result is Double.POSITIVE_INFINITY.

    Note that this implementation is not synchronized. If multiple threads access an instance of this class concurrently, and at least one of the threads invokes the increment() or clear() method, it must be synchronized externally.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Max()
      Create a Max instance
      Max​(Max original)
      Copy constructor, creates a new Max identical to the original
    • Constructor Detail

      • Max

        public Max()
        Create a Max instance
      • Max

        public Max​(Max original)
        Copy constructor, creates a new Max identical to the original
        Parameters:
        original - the Max instance to copy
    • Method Detail

      • getN

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

        public double evaluate​(double[] values,
                               int begin,
                               int length)
        Returns the maximum of the entries in the specified portion of the input array, or Double.NaN if the designated subarray is empty.

        Throws IllegalArgumentException if the array is null or the array index parameters are not valid.

        • The result is NaN iff all values are NaN (i.e. NaN values have no impact on the value of the statistic).
        • If any of the values equals Double.POSITIVE_INFINITY, the result is Double.POSITIVE_INFINITY.

        Specified by:
        evaluate in interface UnivariateStatistic
        Overrides:
        evaluate in class AbstractStorelessUnivariateStatistic
        Parameters:
        values - the input array
        begin - index of the first array element to include
        length - the number of elements to include
        Returns:
        the maximum of the values or Double.NaN if length = 0
        Throws:
        java.lang.IllegalArgumentException - if the array is null or the array index parameters are not valid
        See Also:
        UnivariateStatistic.evaluate(double[], int, int)
      • copy

        public static void copy​(Max source,
                                Max dest)
        Copies source to dest.

        Neither source nor dest can be null.

        Parameters:
        source - Max to copy
        dest - Max to copy to
        Throws:
        java.lang.NullPointerException - if either source or dest is null