Class Max
java.lang.Object
org.hipparchus.stat.descriptive.AbstractStorelessUnivariateStatistic
org.hipparchus.stat.descriptive.rank.Max
- All Implemented Interfaces:
Serializable
,DoubleConsumer
,AggregatableStatistic<Max>
,StorelessUnivariateStatistic
,UnivariateStatistic
,MathArrays.Function
public class Max
extends AbstractStorelessUnivariateStatistic
implements AggregatableStatistic<Max>, Serializable
Returns the maximum of the available values.
- The result is
NaN
iff all values areNaN
(i.e.NaN
values have no impact on the value of the statistic). - If any of the values equals
Double.POSITIVE_INFINITY
, the result isDouble.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:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Aggregates the provided instance into this instance.void
clear()
Clears the internal state of the Statisticcopy()
Returns a copy of the statistic with the same internal state.double
evaluate
(double[] values, int begin, int length) Returns the maximum of the entries in the specified portion of the input array, orDouble.NaN
if the designated subarray is empty.long
getN()
Returns the number of values that have been added.double
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.hipparchus.stat.descriptive.AbstractStorelessUnivariateStatistic
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hipparchus.stat.descriptive.AggregatableStatistic
aggregate, aggregate
Methods inherited from interface java.util.function.DoubleConsumer
andThen
Methods inherited from interface org.hipparchus.stat.descriptive.StorelessUnivariateStatistic
accept, incrementAll, incrementAll
Methods inherited from interface org.hipparchus.stat.descriptive.UnivariateStatistic
evaluate
-
Constructor Details
-
Max
public Max()Create a Max instance. -
Max
Copy constructor, creates a newMax
identical to theoriginal
.- Parameters:
original
- theMax
instance to copy- Throws:
NullArgumentException
- if original is null
-
-
Method Details
-
increment
public void increment(double d) Updates the internal state of the statistic to reflect the addition of the new value.- Specified by:
increment
in interfaceStorelessUnivariateStatistic
- Specified by:
increment
in classAbstractStorelessUnivariateStatistic
- Parameters:
d
- the new value.
-
clear
public void clear()Clears the internal state of the Statistic- Specified by:
clear
in interfaceStorelessUnivariateStatistic
- Specified by:
clear
in classAbstractStorelessUnivariateStatistic
-
getResult
public double getResult()Returns the current value of the Statistic.- Specified by:
getResult
in interfaceStorelessUnivariateStatistic
- Specified by:
getResult
in classAbstractStorelessUnivariateStatistic
- Returns:
- value of the statistic,
Double.NaN
if it has been cleared or just instantiated.
-
getN
public long getN()Returns the number of values that have been added.- Specified by:
getN
in interfaceStorelessUnivariateStatistic
- Returns:
- the number of values.
-
aggregate
Aggregates the provided instance into this instance.This method can be used to combine statistics computed over partitions or subsamples - i.e., the value of this instance after this operation should be the same as if a single statistic would have been applied over the combined dataset.
- Specified by:
aggregate
in interfaceAggregatableStatistic<Max>
- Parameters:
other
- the instance to aggregate into this instance
-
evaluate
Returns the maximum of the entries in the specified portion of the input array, orDouble.NaN
if the designated subarray is empty.Throws
MathIllegalArgumentException
if the array is null or the array index parameters are not valid.- The result is
NaN
iff all values areNaN
(i.e.NaN
values have no impact on the value of the statistic). - If any of the values equals
Double.POSITIVE_INFINITY
, the result isDouble.POSITIVE_INFINITY.
- Specified by:
evaluate
in interfaceMathArrays.Function
- Specified by:
evaluate
in interfaceStorelessUnivariateStatistic
- Specified by:
evaluate
in interfaceUnivariateStatistic
- Parameters:
values
- the input arraybegin
- index of the first array element to includelength
- the number of elements to include- Returns:
- the maximum 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:
- The result is
-
copy
Returns a copy of the statistic with the same internal state.- Specified by:
copy
in interfaceStorelessUnivariateStatistic
- Specified by:
copy
in interfaceUnivariateStatistic
- Specified by:
copy
in classAbstractStorelessUnivariateStatistic
- Returns:
- a copy of the statistic
-