# Uses of Enum Class
org.apache.datasketches.quantilescommon.QuantileSearchCriteria

Packages that use QuantileSearchCriteria
Package
Description
org.apache.datasketches.kll
This package is for the implementations of the sketch algorithm developed by Zohar Karnin, Kevin Lang, and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.
org.apache.datasketches.partitions
org.apache.datasketches.quantiles
The quantiles package contains stochastic streaming algorithms that enable single-pass analysis of the distribution of a stream of quantiles.
org.apache.datasketches.quantilescommon
This package contains common tools and methods for the quantiles, kll and req packages.
org.apache.datasketches.req
This package is for the implementation of the Relative Error Quantiles sketch algorithm.

## Uses of QuantileSearchCriteria in org.apache.datasketches.kll

Methods in org.apache.datasketches.kll with parameters of type QuantileSearchCriteria
Modifier and Type
Method
Description
`double[]`
KllDoublesSketch.`getCDF(double[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
KllFloatsSketch.`getCDF(float[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
KllItemsSketch.`getCDF(T[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
KllLongsSketch.`getCDF(long[] splitPoints, QuantileSearchCriteria searchCrit)`
`GenericPartitionBoundaries<T>`
KllItemsSketch.`getPartitionBoundariesFromNumParts(int numEquallySizedParts, QuantileSearchCriteria searchCrit)`
`GenericPartitionBoundaries<T>`
KllItemsSketch.`getPartitionBoundariesFromPartSize(long nominalPartSizeItems, QuantileSearchCriteria searchCrit)`
`double[]`
KllDoublesSketch.`getPMF(double[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
KllFloatsSketch.`getPMF(float[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
KllItemsSketch.`getPMF(T[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
KllLongsSketch.`getPMF(long[] splitPoints, QuantileSearchCriteria searchCrit)`
`double`
KllDoublesSketch.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`float`
KllFloatsSketch.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`T`
KllItemsSketch.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`long`
KllLongsSketch.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`double[]`
KllDoublesSketch.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
`float[]`
KllFloatsSketch.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
`T[]`
KllItemsSketch.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
`long[]`
KllLongsSketch.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
`double`
KllDoublesSketch.`getRank(double quantile, QuantileSearchCriteria searchCrit)`
`double`
KllFloatsSketch.`getRank(float quantile, QuantileSearchCriteria searchCrit)`
`double`
KllItemsSketch.`getRank(T quantile, QuantileSearchCriteria searchCrit)`
`double`
KllLongsSketch.`getRank(long quantile, QuantileSearchCriteria searchCrit)`
`double[]`
KllDoublesSketch.`getRanks(double[] quantiles, QuantileSearchCriteria searchCrit)`
`double[]`
KllFloatsSketch.`getRanks(float[] quantiles, QuantileSearchCriteria searchCrit)`
`double[]`
KllItemsSketch.`getRanks(T[] quantiles, QuantileSearchCriteria searchCrit)`
`double[]`
KllLongsSketch.`getRanks(long[] quantiles, QuantileSearchCriteria searchCrit)`

## Uses of QuantileSearchCriteria in org.apache.datasketches.partitions

Constructors in org.apache.datasketches.partitions with parameters of type QuantileSearchCriteria
Modifier
Constructor
Description
``
`Partitioner(long tgtPartitionSize, int maxPartsPerSk, SketchFillRequest<T,S> fillReq, QuantileSearchCriteria criteria)`
This constructor includes the QuantileSearchCriteria criteria as a parameter.

## Uses of QuantileSearchCriteria in org.apache.datasketches.quantiles

Methods in org.apache.datasketches.quantiles with parameters of type QuantileSearchCriteria
Modifier and Type
Method
Description
`double[]`
DoublesSketch.`getCDF(double[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
ItemsSketch.`getCDF(T[] splitPoints, QuantileSearchCriteria searchCrit)`
`GenericPartitionBoundaries<T>`
ItemsSketch.`getPartitionBoundariesFromNumParts(int numEquallySizedParts, QuantileSearchCriteria searchCrit)`
`GenericPartitionBoundaries<T>`
ItemsSketch.`getPartitionBoundariesFromPartSize(long nominalPartSizeItems, QuantileSearchCriteria searchCrit)`
`double[]`
DoublesSketch.`getPMF(double[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
ItemsSketch.`getPMF(T[] splitPoints, QuantileSearchCriteria searchCrit)`
`double`
DoublesSketch.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`T`
ItemsSketch.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`double[]`
DoublesSketch.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
`T[]`
ItemsSketch.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
`double`
DoublesSketch.`getRank(double quantile, QuantileSearchCriteria searchCrit)`
`double`
ItemsSketch.`getRank(T quantile, QuantileSearchCriteria searchCrit)`
`double[]`
DoublesSketch.`getRanks(double[] quantiles, QuantileSearchCriteria searchCrit)`
`double[]`
ItemsSketch.`getRanks(T[] quantiles, QuantileSearchCriteria searchCrit)`

## Uses of QuantileSearchCriteria in org.apache.datasketches.quantilescommon

Methods in org.apache.datasketches.quantilescommon that return QuantileSearchCriteria
Modifier and Type
Method
Description
`QuantileSearchCriteria`
GenericPartitionBoundaries.`getSearchCriteria()`
Gets the search criteria specified for the source sketch
`static QuantileSearchCriteria`
QuantileSearchCriteria.`valueOf(String name)`
Returns the enum constant of this class with the specified name.
`static QuantileSearchCriteria[]`
QuantileSearchCriteria.`values()`
Returns an array containing the constants of this enum class, in the order they are declared.
Methods in org.apache.datasketches.quantilescommon with parameters of type QuantileSearchCriteria
Modifier and Type
Method
Description
`default double[]`
DoublesSortedView.`getCDF(double[] 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.
`default double[]`
FloatsSortedView.`getCDF(float[] 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.
`default double[]`
GenericSortedView.`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.
`default double[]`
LongsSortedView.`getCDF(long[] 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.
`double[]`
QuantilesDoublesAPI.`getCDF(double[] 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.
`double[]`
QuantilesFloatsAPI.`getCDF(float[] 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.
`double[]`
QuantilesGenericAPI.`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.
`double[]`
QuantilesLongsAPI.`getCDF(long[] 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.
`static double`
QuantilesUtil.`getNaturalRank(double normalizedRank, long totalN, QuantileSearchCriteria searchCrit)`
Computes the closest Natural Rank from a given Normalized Rank
`long`
SortedViewIterator.`getNaturalRank(QuantileSearchCriteria searchCrit)`
Gets the natural rank at the current index (or previous index) based on the chosen search criterion.
`double`
SortedViewIterator.`getNormalizedRank(QuantileSearchCriteria searchCrit)`
Gets the normalized rank at the current index (or previous index) based on the chosen search criterion.
`GenericPartitionBoundaries<T>`
ItemsSketchSortedView.`getPartitionBoundariesFromNumParts(int numEquallySizedParts, QuantileSearchCriteria searchCrit)`
`GenericPartitionBoundaries<T>`
PartitioningFeature.`getPartitionBoundariesFromNumParts(int numEquallySizedParts, QuantileSearchCriteria searchCrit)`
This method returns an instance of `GenericPartitionBoundaries` which provides sufficient information for the user to create the given number of equally sized partitions, where "equally sized" refers to an approximately equal number of items per partition.
`GenericPartitionBoundaries<T>`
ItemsSketchSortedView.`getPartitionBoundariesFromPartSize(long nominalPartitionSize, QuantileSearchCriteria searchCrit)`
`GenericPartitionBoundaries<T>`
PartitioningFeature.`getPartitionBoundariesFromPartSize(long nominalPartSizeItems, QuantileSearchCriteria searchCrit)`
This method returns an instance of `GenericPartitionBoundaries` which provides sufficient information for the user to create the given number of equally sized partitions, where "equally sized" refers to an approximately equal number of items per partition.
`default double[]`
DoublesSortedView.`getPMF(double[] 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 double[]`
FloatsSortedView.`getPMF(float[] 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 double[]`
GenericSortedView.`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 double[]`
LongsSortedView.`getPMF(long[] 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.
`double[]`
QuantilesDoublesAPI.`getPMF(double[] 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.
`double[]`
QuantilesFloatsAPI.`getPMF(float[] 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.
`double[]`
QuantilesGenericAPI.`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.
`double[]`
QuantilesLongsAPI.`getPMF(long[] 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.
`double`
DoublesSketchSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`double`
DoublesSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`float`
FloatsSketchSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`float`
FloatsSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`T`
GenericSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`T`
GenericSortedViewIterator.`getQuantile(QuantileSearchCriteria searchCrit)`
Gets the quantile at the current index (or previous index) based on the chosen search criterion.
`T`
ItemsSketchSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`long`
LongsSketchSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
`long`
LongsSortedView.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`double`
QuantilesDoublesAPI.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`float`
QuantilesFloatsAPI.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`T`
QuantilesGenericAPI.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`long`
QuantilesLongsAPI.`getQuantile(double rank, QuantileSearchCriteria searchCrit)`
Gets the approximate quantile of the given normalized rank and the given search criterion.
`T[]`
ItemsSketchSortedView.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
Gets an array of quantiles corresponding to the given array of ranks.
`double[]`
QuantilesDoublesAPI.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
Gets an array of quantiles from the given array of normalized ranks.
`float[]`
QuantilesFloatsAPI.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
Gets an array of quantiles from the given array of normalized ranks.
`T[]`
QuantilesGenericAPI.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
Gets an array of quantiles from the given array of normalized ranks.
`long[]`
QuantilesLongsAPI.`getQuantiles(double[] ranks, QuantileSearchCriteria searchCrit)`
Gets an array of quantiles from the given array of normalized ranks.
`double`
DoublesSketchSortedView.`getRank(double quantile, QuantileSearchCriteria searchCrit)`
`double`
DoublesSortedView.`getRank(double quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double`
FloatsSketchSortedView.`getRank(float quantile, QuantileSearchCriteria searchCrit)`
`double`
FloatsSortedView.`getRank(float quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double`
GenericSortedView.`getRank(T quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double`
ItemsSketchSortedView.`getRank(T quantile, QuantileSearchCriteria searchCrit)`
`double`
LongsSketchSortedView.`getRank(long quantile, QuantileSearchCriteria searchCrit)`
`double`
LongsSortedView.`getRank(long quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double`
QuantilesDoublesAPI.`getRank(double quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double`
QuantilesFloatsAPI.`getRank(float quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double`
QuantilesGenericAPI.`getRank(T quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double`
QuantilesLongsAPI.`getRank(long quantile, QuantileSearchCriteria searchCrit)`
Gets the normalized rank corresponding to the given a quantile.
`double[]`
QuantilesDoublesAPI.`getRanks(double[] quantiles, QuantileSearchCriteria searchCrit)`
Gets an array of normalized ranks corresponding to the given array of quantiles and the given search criterion.
`double[]`
QuantilesFloatsAPI.`getRanks(float[] quantiles, QuantileSearchCriteria searchCrit)`
Gets an array of normalized ranks corresponding to the given array of quantiles and the given search criterion.
`double[]`
QuantilesGenericAPI.`getRanks(T[] quantiles, QuantileSearchCriteria searchCrit)`
Gets an array of normalized ranks corresponding to the given array of quantiles and the given search criterion.
`double[]`
QuantilesLongsAPI.`getRanks(long[] quantiles, QuantileSearchCriteria searchCrit)`
Gets an array of normalized ranks corresponding to the given array of quantiles and the given search criterion.
Constructors in org.apache.datasketches.quantilescommon with parameters of type QuantileSearchCriteria
Modifier
Constructor
Description
``
`GenericPartitionBoundaries(long totalN, T[] boundaries, long[] natRanks, double[] normRanks, T maxItem, T minItem, QuantileSearchCriteria searchCrit)`
Constructor.

## Uses of QuantileSearchCriteria in org.apache.datasketches.req

Methods in org.apache.datasketches.req with parameters of type QuantileSearchCriteria
Modifier and Type
Method
Description
`double[]`
ReqSketch.`getCDF(float[] splitPoints, QuantileSearchCriteria searchCrit)`
`double[]`
ReqSketch.`getPMF(float[] splitPoints, QuantileSearchCriteria searchCrit)`
`float`
ReqSketch.`getQuantile(double normRank, QuantileSearchCriteria searchCrit)`
`float[]`
ReqSketch.`getQuantiles(double[] normRanks, QuantileSearchCriteria searchCrit)`
`double`
ReqSketch.`getRank(float quantile, QuantileSearchCriteria searchCrit)`
`double[]`
ReqSketch.`getRanks(float[] quantiles, QuantileSearchCriteria searchCrit)`