T
- The generic quantile type.public interface GenericSortedView<T> extends PartitioningFeature<T>, SketchPartitionLimits, SortedView
SortedView
Modifier and Type | Method and Description |
---|---|
default double[] |
getCDF(T[] splitPoints,
QuantileSearchCriteria searchCrit)
Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream
as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0],
given a set of splitPoints.
|
Comparator<? super T> |
getComparator()
Gets the Comparator for this generic type.
|
T |
getMaxItem()
Returns the maximum item of the stream.
|
T |
getMinItem()
Returns the minimum item of the stream.
|
default double[] |
getPMF(T[] splitPoints,
QuantileSearchCriteria searchCrit)
Returns an approximation to the Probability Mass Function (PMF) of the input stream
as an array of probability masses as doubles on the interval [0.0, 1.0],
given a set of splitPoints.
|
T |
getQuantile(double rank,
QuantileSearchCriteria searchCrit)
Gets the approximate quantile of the given normalized rank and the given search criterion.
|
T[] |
getQuantiles()
Returns the full array of quantiles.
|
double |
getRank(T quantile,
QuantileSearchCriteria searchCrit)
Gets the normalized rank corresponding to the given a quantile.
|
GenericSortedViewIterator<T> |
iterator()
Returns an iterator for this Sorted View.
|
static <T> void |
validateItems(T[] items,
Comparator<? super T> comparator)
Checks the sequential validity of the given array of generic items.
|
getPartitionBoundariesFromNumParts, getPartitionBoundariesFromNumParts, getPartitionBoundariesFromPartSize, getPartitionBoundariesFromPartSize
getMaxPartitions, getMinPartitionSizeItems, getN
getCumulativeWeights, getN, getNumRetained, isEmpty
default double[] getCDF(T[] splitPoints, QuantileSearchCriteria searchCrit)
If the sketch is empty this returns null.
The resulting approximations have a probabilistic guarantee that can be obtained from the getNormalizedRankError(false) function.
splitPoints
- an array of m unique, monotonically increasing items
(of the same type as the input items)
that divide the item input domain into m+1 overlapping intervals.
The start of each interval is below the lowest item retained by the sketch corresponding to a zero rank or zero probability, and the end of the interval is the rank or cumulative probability corresponding to the split point.
The (m+1)th interval represents 100% of the distribution represented by the sketch and consistent with the definition of a cumulative probability distribution, thus the (m+1)th rank or probability in the returned array is always 1.0.
If a split point exactly equals a retained item of the sketch and the search criterion is:
It is not recommended to include either the minimum or maximum items of the input stream.
searchCrit
- the desired search criteria.IllegalArgumentException
- if sketch is empty.Comparator<? super T> getComparator()
T getMaxItem()
IllegalArgumentException
- if sketch is empty.T getMinItem()
IllegalArgumentException
- if sketch is empty.default double[] getPMF(T[] splitPoints, QuantileSearchCriteria searchCrit)
The resulting approximations have a probabilistic guarantee that can be obtained from the getNormalizedRankError(true) function.
splitPoints
- an array of m unique, monotonically increasing items
(of the same type as the input items)
that divide the item input domain into m+1 consecutive, non-overlapping intervals.
Each interval except for the end intervals starts with a split point and ends with the next split point in sequence.
The first interval starts below the lowest item retained by the sketch corresponding to a zero rank or zero probability, and ends with the first split point
The last (m+1)th interval starts with the last split point and ends after the last item retained by the sketch corresponding to a rank or probability of 1.0.
The sum of the probability masses of all (m+1) intervals is 1.0.
If the search criterion is:
It is not recommended to include either the minimum or maximum items of the input stream.
searchCrit
- the desired search criteria.IllegalArgumentException
- if sketch is empty.T getQuantile(double rank, QuantileSearchCriteria searchCrit)
rank
- the given normalized rank, a double in the range [0.0, 1.0].searchCrit
- If INCLUSIVE, the given rank includes all quantiles ≤
the quantile directly corresponding to the given rank.
If EXCLUSIVE, he given rank includes all quantiles <
the quantile directly corresponding to the given rank.IllegalArgumentException
- if sketch is empty.QuantileSearchCriteria
T[] getQuantiles()
double getRank(T quantile, QuantileSearchCriteria searchCrit)
quantile
- the given quantilesearchCrit
- if INCLUSIVE the given quantile is included into the rank.IllegalArgumentException
- if sketch is empty.QuantileSearchCriteria
GenericSortedViewIterator<T> iterator()
SortedView
iterator
in interface SortedView
static <T> void validateItems(T[] items, Comparator<? super T> comparator)
T
- the data typeitems
- given array of generic itemscomparator
- the comparator for generic item data type TCopyright © 2015–2024 The Apache Software Foundation. All rights reserved.