org.apache.datasketches.quantilescommon

Interface PartitionBoundaries

All Known Implementing Classes:

GenericPartitionBoundaries

public interface PartitionBoundaries

This defines a set of results computed from the getParitionBoundaries() function and encapsulates the basic methods needed to construct actual partitions based on generic items.

Method Summary

Modifier and Type	Method and Description
long	getN() Gets the length of the input stream offered to the underlying sketch.
long[]	getNaturalRanks() Gets an ordered array of natural ranks of the associated array of partition boundaries utilizing a specified search criterion.
double[]	getNormalizedRanks() Gets an ordered array of normalized ranks of the associated array of partition boundaries utilizing a specified search criterion.
long[]	getNumDeltaItems() Gets the number of items to be included for each partition as an array.
int	getNumPartitions() Gets the number of partitions
QuantileSearchCriteria	getSearchCriteria() Gets the search criteria specified for the source sketch

Method Detail

getN

long getN()

Gets the length of the input stream offered to the underlying sketch.

Returns:

the length of the input stream offered to the underlying sketch.

getNaturalRanks

long[] getNaturalRanks()

Gets an ordered array of natural ranks of the associated array of partition boundaries utilizing a specified search criterion. Natural ranks are integral values on the interval [1, N]

Returns:

an array of natural ranks.

getNormalizedRanks

double[] getNormalizedRanks()

Gets an ordered array of normalized ranks of the associated array of partition boundaries utilizing a specified search criterion. Normalized ranks are double values on the interval [0.0, 1.0].

Returns:

an array of normalized ranks.

getNumDeltaItems

long[] getNumDeltaItems()

Gets the number of items to be included for each partition as an array. The count at index 0 is 0. The number of items included in the first partition, defined by the boundaries at index 0 and index 1, is at index 1 in this array, etc.

Returns:

the number of items to be included for each partition as an array.

getNumPartitions

int getNumPartitions()

Gets the number of partitions

Returns:

the number of partitions

getSearchCriteria

QuantileSearchCriteria getSearchCriteria()

Gets the search criteria specified for the source sketch

Returns:

The search criteria specified for the source sketch