Class Median
- java.lang.Object
-
- org.apache.commons.math4.legacy.stat.descriptive.AbstractUnivariateStatistic
-
- org.apache.commons.math4.legacy.stat.descriptive.rank.Percentile
-
- org.apache.commons.math4.legacy.stat.descriptive.rank.Median
-
- All Implemented Interfaces:
MathArrays.Function,UnivariateStatistic
public class Median extends Percentile
Returns the median of the available values. This is the same as the 50th percentile. SeePercentilefor 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()orclear()method, it must be synchronized externally.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.commons.math4.legacy.stat.descriptive.rank.Percentile
Percentile.EstimationType
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MedianwithEstimationType(Percentile.EstimationType newEstimationType)Build a new instance similar to the current one except for theestimation type.MedianwithKthSelector(KthSelector newKthSelector)Build a new instance similar to the current one except for thekthSelectorinstance specifically set.MedianwithNaNStrategy(NaNStrategy newNaNStrategy)Build a new instance similar to the current one except for theNaN handlingstrategy.-
Methods inherited from class org.apache.commons.math4.legacy.stat.descriptive.rank.Percentile
copy, evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, getEstimationType, getKthSelector, getNaNStrategy, getPivotingStrategy, getQuantile, getWorkArray, setData, setData, setData, setData, setQuantile
-
Methods inherited from class org.apache.commons.math4.legacy.stat.descriptive.AbstractUnivariateStatistic
evaluate, evaluate, getData, getDataRef
-
-
-
-
Constructor Detail
-
Median
public Median()
Default constructor.
-
Median
public Median(Median original) throws NullArgumentException
Copy constructor, creates a newMedianidentical. to theoriginal- Parameters:
original- theMedianinstance to copy- Throws:
NullArgumentException- if original is null
-
-
Method Detail
-
withEstimationType
public Median withEstimationType(Percentile.EstimationType newEstimationType)
Build a new instance similar to the current one except for theestimation type.This method is intended to be used as part of a fluent-type builder pattern. Building finely tune instances should be done as follows:
Percentile customized = new Percentile(quantile). withEstimationType(estimationType). withNaNStrategy(nanStrategy). withKthSelector(kthSelector);If any of the
withXxxmethod is omitted, the default value for the corresponding customization parameter will be used.- Overrides:
withEstimationTypein classPercentile- Parameters:
newEstimationType- estimation type for the new instance. Cannot benull.- Returns:
- a new instance, with changed estimation type
-
withNaNStrategy
public Median withNaNStrategy(NaNStrategy newNaNStrategy)
Build a new instance similar to the current one except for theNaN handlingstrategy.This method is intended to be used as part of a fluent-type builder pattern. Building finely tune instances should be done as follows:
Percentile customized = new Percentile(quantile). withEstimationType(estimationType). withNaNStrategy(nanStrategy). withKthSelector(kthSelector);If any of the
withXxxmethod is omitted, the default value for the corresponding customization parameter will be used.- Overrides:
withNaNStrategyin classPercentile- Parameters:
newNaNStrategy- NaN strategy for the new instance. Cannot benull.- Returns:
- a new instance, with changed NaN handling strategy
-
withKthSelector
public Median withKthSelector(KthSelector newKthSelector)
Build a new instance similar to the current one except for thekthSelectorinstance specifically set.This method is intended to be used as part of a fluent-type builder pattern. Building finely tune instances should be done as follows:
Percentile customized = new Percentile(quantile). withEstimationType(estimationType). withNaNStrategy(nanStrategy). withKthSelector(newKthSelector);If any of the
withXxxmethod is omitted, the default value for the corresponding customization parameter will be used.- Overrides:
withKthSelectorin classPercentile- Parameters:
newKthSelector- KthSelector for the new instance. Cannot benull.- Returns:
- a new instance, with changed KthSelector
-
-