Package org.apache.datasketches.quantilescommon

Class FloatsSketchSortedView

java.lang.Object

org.apache.datasketches.quantilescommon.FloatsSketchSortedView

All Implemented Interfaces:

FloatsSortedView, SortedView

public class FloatsSketchSortedView
extends Object
implements FloatsSortedView

The SortedView for the KllFloatsSketch and the ReqSketch.

Author:

Alexander Saydakov, Lee Rhodes

Constructor Summary

Constructors

Constructor	Description
FloatsSketchSortedView(float[] quantiles, long[] cumWeights, QuantilesFloatsAPI sk)	Construct Sorted View.

Method Summary

Modifier and Type	Method	Description
long[]	getCumulativeWeights()	Returns the array of cumulative weights from the sketch.
float	getMaxItem()	Returns the maximum item of the stream.
float	getMinItem()	Returns the minimum item of the stream.
long	getN()	Returns the total number of items presented to the sourcing sketch.
int	getNumRetained()	Gets the number of quantiles retained by this sorted view.
float	getQuantile(double rank, QuantileSearchCriteria searchCrit)	Gets the approximate quantile of the given normalized rank and the given search criterion.
float[]	getQuantiles()	Returns an array of all retained quantiles by the sketch.
double	getRank(float quantile, QuantileSearchCriteria searchCrit)	Gets the normalized rank corresponding to the given a quantile.
boolean	isEmpty()	Returns true if this sorted view is empty.
FloatsSortedViewIterator	iterator()	Returns an iterator for this Sorted View.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.datasketches.quantilescommon.FloatsSortedView

getCDF, getPMF

Constructor Detail

FloatsSketchSortedView

public FloatsSketchSortedView(float[] quantiles,
                              long[] cumWeights,
                              QuantilesFloatsAPI sk)

Construct Sorted View.

Parameters:

quantiles - sorted array of quantiles

cumWeights - sorted, monotonically increasing cumulative weights.

sk - the underlying quantile sketch.

Method Detail

getCumulativeWeights

public long[] getCumulativeWeights()

Description copied from interface: SortedView

Returns the array of cumulative weights from the sketch. Also known as the natural ranks, which are the Natural Numbers on the interval [1, N].

Specified by:

getCumulativeWeights in interface SortedView

Returns:

the array of cumulative weights (or natural ranks).

getMaxItem

public float getMaxItem()

Description copied from interface: FloatsSortedView

Returns the maximum item of the stream. This may be distinct from the largest item retained by the sketch algorithm.

Specified by:

getMaxItem in interface FloatsSortedView

Returns:

the maximum item of the stream

getMinItem

public float getMinItem()

Description copied from interface: FloatsSortedView

Returns the minimum item of the stream. This may be distinct from the smallest item retained by the sketch algorithm.

Specified by:

getMinItem in interface FloatsSortedView

Returns:

the minimum item of the stream

getN

public long getN()

Description copied from interface: SortedView

Returns the total number of items presented to the sourcing sketch.

Specified by:

getN in interface SortedView

Returns:

the total number of items presented to the sourcing sketch.

getNumRetained

public int getNumRetained()

Description copied from interface: SortedView

Gets the number of quantiles retained by this sorted view. This may be slightly different from the function with the same name when called from the originating sketch.

Specified by:

getNumRetained in interface SortedView

Returns:

the number of quantiles retained by this sorted view

getQuantile

public float getQuantile(double rank,
                         QuantileSearchCriteria searchCrit)

Description copied from interface: FloatsSortedView

Gets the approximate quantile of the given normalized rank and the given search criterion.

Specified by:

getQuantile in interface FloatsSortedView

Parameters:

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.

Returns:

the approximate quantile given the normalized rank.

See Also:

QuantileSearchCriteria

getQuantiles

public float[] getQuantiles()

Description copied from interface: FloatsSortedView

Returns an array of all retained quantiles by the sketch.

Specified by:

getQuantiles in interface FloatsSortedView

Returns:

an array of all retained quantiles by the sketch.

getRank

public double getRank(float quantile,
                      QuantileSearchCriteria searchCrit)

Description copied from interface: FloatsSortedView

Gets the normalized rank corresponding to the given a quantile.

Specified by:

getRank in interface FloatsSortedView

Parameters:

quantile - the given quantile

searchCrit - if INCLUSIVE the given quantile is included into the rank.

Returns:

the normalized rank corresponding to the given quantile.

See Also:

QuantileSearchCriteria

isEmpty

public boolean isEmpty()

Description copied from interface: SortedView

Returns true if this sorted view is empty.

Specified by:

isEmpty in interface SortedView

Returns:

true if this sorted view is empty.

iterator

public FloatsSortedViewIterator iterator()

Description copied from interface: SortedView

Returns an iterator for this Sorted View.

Specified by:

iterator in interface FloatsSortedView

Specified by:

iterator in interface SortedView

Returns:

an iterator for this Sorted View.