Class Min
- java.lang.Object
-
- org.apache.commons.math4.legacy.stat.descriptive.AbstractStorelessUnivariateStatistic
-
- org.apache.commons.math4.legacy.stat.descriptive.rank.Min
-
- All Implemented Interfaces:
MathArrays.Function,StorelessUnivariateStatistic,UnivariateStatistic
public class Min extends AbstractStorelessUnivariateStatistic
Returns the minimum of the available values.- The result is
NaNiff all values areNaN(i.e.NaNvalues have no impact on the value of the statistic). - If any of the values equals
Double.NEGATIVE_INFINITY, the result isDouble.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()orclear()method, it must be synchronized externally.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clears the internal state of the Statistic.Mincopy()Returns a copy of the statistic with the same internal state.static voidcopy(Min source, Min dest)Copies source to dest.doubleevaluate(double[] values, int begin, int length)Returns the minimum of the entries in the specified portion of the input array, orDouble.NaNif the designated subarray is empty.longgetN()Returns the number of values that have been added.doublegetResult()Returns the current value of the Statistic.voidincrement(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.legacy.stat.descriptive.AbstractStorelessUnivariateStatistic
equals, evaluate, hashCode, incrementAll, incrementAll
-
-
-
-
Constructor Detail
-
Min
public Min()
Create a Min instance.
-
Min
public Min(Min original) throws NullArgumentException
Copy constructor, creates a newMinidentical to theoriginal.- Parameters:
original- theMininstance to copy- Throws:
NullArgumentException- if original is null
-
-
Method Detail
-
increment
public void increment(double d)
Updates the internal state of the statistic to reflect the addition of the new value.- Specified by:
incrementin interfaceStorelessUnivariateStatistic- Specified by:
incrementin classAbstractStorelessUnivariateStatistic- Parameters:
d- the new value.
-
clear
public void clear()
Clears the internal state of the Statistic.- Specified by:
clearin interfaceStorelessUnivariateStatistic- Specified by:
clearin classAbstractStorelessUnivariateStatistic
-
getResult
public double getResult()
Returns the current value of the Statistic.- Specified by:
getResultin interfaceStorelessUnivariateStatistic- Specified by:
getResultin classAbstractStorelessUnivariateStatistic- Returns:
- value of the statistic,
Double.NaNif it has been cleared or just instantiated.
-
getN
public long getN()
Returns the number of values that have been added.- Returns:
- the number of values.
-
evaluate
public double evaluate(double[] values, int begin, int length) throws MathIllegalArgumentException
Returns the minimum of the entries in the specified portion of the input array, orDouble.NaNif the designated subarray is empty.Throws
MathIllegalArgumentExceptionif the array is null or the array index parameters are not valid.- The result is
NaNiff all values areNaN(i.e.NaNvalues have no impact on the value of the statistic). - If any of the values equals
Double.NEGATIVE_INFINITY, the result isDouble.NEGATIVE_INFINITY.
- Specified by:
evaluatein interfaceMathArrays.Function- Specified by:
evaluatein interfaceUnivariateStatistic- Overrides:
evaluatein classAbstractStorelessUnivariateStatistic- Parameters:
values- the input arraybegin- index of the first array element to includelength- the number of elements to include- Returns:
- the minimum of the values or Double.NaN if length = 0
- Throws:
MathIllegalArgumentException- if the array is null or the array index parameters are not valid- See Also:
UnivariateStatistic.evaluate(double[], int, int)
- The result is
-
copy
public Min copy()
Returns a copy of the statistic with the same internal state.- Specified by:
copyin interfaceStorelessUnivariateStatistic- Specified by:
copyin interfaceUnivariateStatistic- Specified by:
copyin classAbstractStorelessUnivariateStatistic- Returns:
- a copy of the statistic
-
copy
public static void copy(Min source, Min dest) throws NullArgumentException
Copies source to dest.Neither source nor dest can be null.
- Parameters:
source- Min to copydest- Min to copy to- Throws:
NullArgumentException- if either source or dest is null
-
-