public class Max extends AbstractStorelessUnivariateStatistic implements Serializable
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 and Description |
---|
Max()
Create a Max instance
|
Max(Max original)
Copy constructor, creates a new
Max identical
to the original |
Modifier and Type | Method and 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.
|
equals, evaluate, hashCode, incrementAll, incrementAll
evaluate, getData, getDataRef, setData, setData, test, test, test, test
public Max()
public Max(Max original)
Max
identical
to the original
original
- the Max
instance to copyNullArgumentException
- if original is nullpublic void increment(double d)
increment
in interface StorelessUnivariateStatistic
increment
in class AbstractStorelessUnivariateStatistic
d
- the new value.public void clear()
clear
in interface StorelessUnivariateStatistic
clear
in class AbstractStorelessUnivariateStatistic
public double getResult()
getResult
in interface StorelessUnivariateStatistic
getResult
in class AbstractStorelessUnivariateStatistic
Double.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 MathIllegalArgumentException
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 UnivariateStatistic
evaluate
in interface MathArrays.Function
evaluate
in class AbstractStorelessUnivariateStatistic
values
- the input arraybegin
- index of the first array element to includelength
- the number of elements to includeMathIllegalArgumentException
- if the array is null or the array index
parameters are not validUnivariateStatistic.evaluate(double[], int, int)
public Max copy()
copy
in interface StorelessUnivariateStatistic
copy
in interface UnivariateStatistic
copy
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 toNullArgumentException
- if either source or dest is nullCopyright © 2017 CNES. All rights reserved.