Class Median
java.lang.Object
org.hipparchus.stat.descriptive.AbstractUnivariateStatistic
org.hipparchus.stat.descriptive.rank.Median
- All Implemented Interfaces:
Serializable
,UnivariateStatistic
,MathArrays.Function
Returns the median of the available values. This is the same as the 50th percentile.
See
Percentile
for a description of the algorithm used.
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 TypeMethodDescriptioncopy()
Returns a copy of the statistic with the same internal state.double
evaluate
(double[] values, int begin, int length) Returns the result of evaluating the statistic over the specified entries in the input array.Get the estimationtype
used for computation.Get thekthSelector
used for computation.Get theNaN Handling
strategy used for computation.withEstimationType
(Percentile.EstimationType newEstimationType) Build a new instance similar to the current one except for theestimation type
.withKthSelector
(KthSelector newKthSelector) Build a new instance similar to the current one except for thekthSelector
instance specifically set.withNaNStrategy
(NaNStrategy newNaNStrategy) Build a new instance similar to the current one except for theNaN handling
strategy.Methods inherited from class org.hipparchus.stat.descriptive.AbstractUnivariateStatistic
evaluate, getData, getDataRef, setData, setData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hipparchus.stat.descriptive.UnivariateStatistic
evaluate
-
Constructor Details
-
Median
public Median()Default constructor.
-
-
Method Details
-
evaluate
Returns the result of evaluating the statistic over the specified entries in the input array.- Specified by:
evaluate
in interfaceMathArrays.Function
- Specified by:
evaluate
in interfaceUnivariateStatistic
- Specified by:
evaluate
in classAbstractUnivariateStatistic
- Parameters:
values
- the input arraybegin
- the index of the first element to includelength
- the number of elements to include- Returns:
- the value of the statistic applied to the included array entries
- Throws:
MathIllegalArgumentException
- if values is null or the indices are invalid
-
copy
Returns a copy of the statistic with the same internal state.- Specified by:
copy
in interfaceUnivariateStatistic
- Specified by:
copy
in classAbstractUnivariateStatistic
- Returns:
- a copy of the statistic
-
getEstimationType
Get the estimationtype
used for computation.- Returns:
- the
estimationType
set
-
withEstimationType
Build a new instance similar to the current one except for theestimation type
.- Parameters:
newEstimationType
- estimation type for the new instance- Returns:
- a new instance, with changed estimation type
- Throws:
NullArgumentException
- when newEstimationType is null
-
getNaNStrategy
Get theNaN Handling
strategy used for computation.- Returns:
NaN Handling
strategy set during construction
-
withNaNStrategy
Build a new instance similar to the current one except for theNaN handling
strategy.- Parameters:
newNaNStrategy
- NaN strategy for the new instance- Returns:
- a new instance, with changed NaN handling strategy
- Throws:
NullArgumentException
- when newNaNStrategy is null
-
getKthSelector
Get thekthSelector
used for computation.- Returns:
- the
kthSelector
set
-
withKthSelector
Build a new instance similar to the current one except for thekthSelector
instance specifically set.- Parameters:
newKthSelector
- KthSelector for the new instance- Returns:
- a new instance, with changed KthSelector
- Throws:
NullArgumentException
- when newKthSelector is null
-