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

Class Min

java.lang.Object
org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic
org.apache.commons.math.stat.descriptive.rank.Min
All Implemented Interfaces:
Serializable, StorelessUnivariateStatistic, UnivariateStatistic
public class Min extends AbstractStorelessUnivariateStatistic implements Serializable
Returns the minimum 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.NEGATIVE_INFINITY, the result is Double.NEGATIVE_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:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Min()
    Create a Min instance
    Min(Min original)
    Copy constructor, creates a new Min identical to the original

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clears the internal state of the Statistic
    Min
    copy()
    Returns a copy of the statistic with the same internal state.
    static void
    copy(Min source, Min dest)
    Copies source to dest.
    double
    evaluate(double[] values, int begin, int length)
    Returns the minimum 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.math.stat.descriptive.AbstractStorelessUnivariateStatistic

    equals, evaluate, hashCode, incrementAll, incrementAll

    Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic

    evaluate, getData, setData, setData

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Min

      public Min()
      Create a Min instance

    • Min

      public Min(Min original)
      Copy constructor, creates a new Min identical to the original
      Parameters:
      original - the Min instance to copy

  • Method Details