Package org.apache.commons.math4.stat.descriptive.rank

Class Max

java.lang.Object
org.apache.commons.math4.stat.descriptive.AbstractStorelessUnivariateStatistic
org.apache.commons.math4.stat.descriptive.rank.Max
All Implemented Interfaces:
java.io.Serializable, StorelessUnivariateStatistic, UnivariateStatistic, MathArrays.Function
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.

  • Method Summary

    Modifier and Type Method Description
    void clear()
    Clears the internal state of the Statistic
    Max copy()
    Returns a copy of the statistic with the same internal state.
    static void copy​(Max source, Max dest)
    Copies source to dest.
    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.
    long getN()
    Returns the number of values that have been added.
    double getResult()
    Returns the current value of the Statistic.
    void increment​(double d)
    Updates the internal state of the statistic to reflect the addition of the new value.

    Methods inherited from class org.apache.commons.math4.stat.descriptive.AbstractStorelessUnivariateStatistic

    equals, evaluate, hashCode, incrementAll, incrementAll

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait