|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic
org.apache.commons.math.stat.descriptive.AbstractStorelessUnivariateStatistic
org.apache.commons.math.stat.descriptive.rank.Max
public class Max
Returns the maximum of the available values.
NaN iff all values are NaN
(i.e. NaN values have no impact on the value of the statistic).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.
| Constructor Summary | |
|---|---|
Max()
Create a Max instance |
|
Max(Max original)
Copy constructor, creates a new Max identical
to the original |
|
| Method Summary | |
|---|---|
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.math.stat.descriptive.AbstractStorelessUnivariateStatistic |
|---|
equals, evaluate, hashCode, incrementAll, incrementAll |
| Methods inherited from class org.apache.commons.math.stat.descriptive.AbstractUnivariateStatistic |
|---|
evaluate, getData, getDataRef, setData, setData, test, test |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Max()
public Max(Max original)
Max identical
to the original
original - the Max instance to copy| Method Detail |
|---|
public void increment(double d)
increment in interface StorelessUnivariateStatisticincrement in class AbstractStorelessUnivariateStatisticd - the new value.public void clear()
clear in interface StorelessUnivariateStatisticclear in class AbstractStorelessUnivariateStatisticpublic double getResult()
getResult in interface StorelessUnivariateStatisticgetResult in class AbstractStorelessUnivariateStatisticDouble.NaN if it
has been cleared or just instantiated.public long getN()
getN in interface StorelessUnivariateStatistic
public double evaluate(double[] values,
int begin,
int length)
Double.NaN if the designated subarray
is empty.
Throws IllegalArgumentException if the array is null or
the array index parameters are not valid.
NaN iff all values are NaN
(i.e. NaN values have no impact on the value of the statistic).Double.POSITIVE_INFINITY,
the result is Double.POSITIVE_INFINITY.
evaluate in interface UnivariateStatisticevaluate in class AbstractStorelessUnivariateStatisticvalues - the input arraybegin - index of the first array element to includelength - the number of elements to include
IllegalArgumentException - if the array is null or the array index
parameters are not validUnivariateStatistic.evaluate(double[], int, int)public Max copy()
copy in interface StorelessUnivariateStatisticcopy in interface UnivariateStatisticcopy in class AbstractStorelessUnivariateStatistic
public static void copy(Max source,
Max dest)
Neither source nor dest can be null.
source - Max to copydest - Max to copy to
NullPointerException - if either source or dest is null
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||