T
- The given item typepublic interface QuantilesGenericAPI<T> extends QuantilesAPI, PartitioningFeature<T>, SketchPartitionLimits
QuantilesAPI
EMPTY_MSG, MEM_REQ_SVR_NULL_MSG, NOT_SINGLE_ITEM_MSG, SELF_MERGE_MSG, TGT_IS_READ_ONLY_MSG, UNSUPPORTED_MSG
Modifier and Type | Method and Description |
---|---|
default double[] |
getCDF(T[] splitPoints)
This is equivalent to
getCDF(splitPoints, INCLUSIVE) |
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.
|
Class<T> |
getClassOfT() |
Comparator<? super T> |
getComparator()
Returns the Comparator of T
|
T |
getMaxItem()
Returns the maximum item of the stream.
|
default int |
getMaxPartitions()
Gets the maximum number of partitions this sketch will support based on the configured size K
and the number of retained values of this sketch.
|
T |
getMinItem()
Returns the minimum item of the stream.
|
default double[] |
getPMF(T[] splitPoints)
This is equivalent to
getPMF(splitPoints, INCLUSIVE) |
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.
|
default T |
getQuantile(double rank)
This is equivalent to
getQuantile(rank, INCLUSIVE) |
T |
getQuantile(double rank,
QuantileSearchCriteria searchCrit)
Gets the approximate quantile of the given normalized rank and the given search criterion.
|
T |
getQuantileLowerBound(double rank)
Gets the lower bound of the quantile confidence interval in which the quantile of the
given rank exists.
|
default T[] |
getQuantiles(double[] ranks)
This is equivalent to
getQuantiles(ranks, INCLUSIVE) |
T[] |
getQuantiles(double[] ranks,
QuantileSearchCriteria searchCrit)
Gets an array of quantiles from the given array of normalized ranks.
|
T |
getQuantileUpperBound(double rank)
Gets the upper bound of the quantile confidence interval in which the true quantile of the
given rank exists.
|
default double |
getRank(T quantile)
This is equivalent to
getRank(T quantile, INCLUSIVE) |
double |
getRank(T quantile,
QuantileSearchCriteria searchCrit)
Gets the normalized rank corresponding to the given a quantile.
|
default double[] |
getRanks(T[] quantiles)
This is equivalent to
getRanks(quantiles, INCLUSIVE) |
double[] |
getRanks(T[] quantiles,
QuantileSearchCriteria searchCrit)
Gets an array of normalized ranks corresponding to the given array of quantiles and the given
search criterion.
|
GenericSortedView<T> |
getSortedView()
Gets the sorted view of this sketch
|
QuantilesGenericSketchIterator<T> |
iterator()
Gets the iterator for this sketch, which is not sorted.
|
void |
update(T item)
Updates this sketch with the given item.
|
getK, getN, getNormalizedRankError, getNumRetained, getRankLowerBound, getRankUpperBound, hasMemory, isDirect, isEmpty, isEstimationMode, isReadOnly, reset, toString
getPartitionBoundariesFromNumParts, getPartitionBoundariesFromNumParts, getPartitionBoundariesFromPartSize, getPartitionBoundariesFromPartSize
getMinPartitionSizeItems, getN
default double[] getCDF(T[] splitPoints)
getCDF(splitPoints, INCLUSIVE)
splitPoints
- an array of m unique, monotonically increasing items.IllegalArgumentException
- if sketch is empty.double[] getCDF(T[] splitPoints, QuantileSearchCriteria searchCrit)
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.default int getMaxPartitions()
SketchPartitionLimits
getMaxPartitions
in interface SketchPartitionLimits
T getMinItem()
IllegalArgumentException
- if sketch is empty.default double[] getPMF(T[] splitPoints)
getPMF(splitPoints, INCLUSIVE)
splitPoints
- an array of m unique, monotonically increasing items.IllegalArgumentException
- if sketch is empty.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.default T getQuantile(double rank)
getQuantile(rank, INCLUSIVE)
rank
- the given normalized rank, a double in the range [0.0, 1.0].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 getQuantileLowerBound(double rank)
Although it is possible to estimate the probability that the true quantile exists within the quantile confidence interval specified by the upper and lower quantile bounds, it is not possible to guarantee the width of the quantile confidence interval as an additive or multiplicative percent of the true quantile.
rank
- the given normalized rankIllegalArgumentException
- if sketch is empty.T getQuantileUpperBound(double rank)
Although it is possible to estimate the probability that the true quantile exists within the quantile confidence interval specified by the upper and lower quantile bounds, it is not possible to guarantee the width of the quantile interval as an additive or multiplicative percent of the true quantile.
rank
- the given normalized rankIllegalArgumentException
- if sketch is empty.default T[] getQuantiles(double[] ranks)
getQuantiles(ranks, INCLUSIVE)
ranks
- the given array of normalized ranks, each of which must be
in the interval [0.0,1.0].IllegalArgumentException
- if sketch is empty.T[] getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)
ranks
- the given array of normalized ranks, each of which must be
in the interval [0.0,1.0].searchCrit
- if INCLUSIVE, the given ranks include all quantiles ≤
the quantile directly corresponding to each rank.IllegalArgumentException
- if sketch is empty.QuantileSearchCriteria
default double getRank(T quantile)
getRank(T quantile, INCLUSIVE)
quantile
- the given quantileIllegalArgumentException
- if sketch is empty.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
default double[] getRanks(T[] quantiles)
getRanks(quantiles, INCLUSIVE)
quantiles
- the given array of quantilesIllegalArgumentException
- if sketch is empty.double[] getRanks(T[] quantiles, QuantileSearchCriteria searchCrit)
quantiles
- the given array of quantilessearchCrit
- if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.IllegalArgumentException
- if sketch is empty.QuantileSearchCriteria
GenericSortedView<T> getSortedView()
QuantilesGenericSketchIterator<T> iterator()
void update(T item)
item
- from a stream of items. Nulls are ignored.Copyright © 2015–2024 The Apache Software Foundation. All rights reserved.