Package org.apache.datasketches.kll

Class KllDoublesSketchSortedView

java.lang.Object

org.apache.datasketches.kll.KllDoublesSketchSortedView

All Implemented Interfaces:

DoublesSortedView, SortedView

public final class KllDoublesSketchSortedView
extends Object
implements DoublesSortedView

The SortedView of the KllDoublesSketch.

Author:

Alexander Saydakov, Lee Rhodes

Constructor Summary

Constructors

Constructor	Description
KllDoublesSketchSortedView(KllDoublesSketch sk)	Constructs this Sorted View given the sketch

Method Summary

Modifier and Type	Method	Description
long[]	getCumulativeWeights()	Returns the array of cumulative weights
double	getQuantile(double rank, QuantileSearchCriteria searchCrit)	Gets the approximate quantile of the given normalized rank and the given search criterion.
double[]	getQuantiles()	Returns the array of quantiles.
double	getRank(double quantile, QuantileSearchCriteria searchCrit)	Gets the normalized rank corresponding to the given a quantile.
boolean	isEmpty()	Returns true if this sorted view is empty.
KllDoublesSketchSortedViewIterator	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.DoublesSortedView

getCDF, getPMF

Constructor Detail

KllDoublesSketchSortedView

public KllDoublesSketchSortedView(KllDoublesSketch sk)

Constructs this Sorted View given the sketch

Parameters:

sk - the given KllDoublesSketch.

Method Detail

getCumulativeWeights

public long[] getCumulativeWeights()

Description copied from interface: SortedView

Returns the array of cumulative weights

Specified by:

getCumulativeWeights in interface SortedView

Returns:

the array of cumulative weights

getQuantile

public double getQuantile(double rank,
                          QuantileSearchCriteria searchCrit)

Description copied from interface: DoublesSortedView

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

Specified by:

getQuantile in interface DoublesSortedView

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 double[] getQuantiles()

Description copied from interface: DoublesSortedView

Returns the array of quantiles.

Specified by:

getQuantiles in interface DoublesSortedView

Returns:

the array of quantiles.

getRank

public double getRank(double quantile,
                      QuantileSearchCriteria searchCrit)

Description copied from interface: DoublesSortedView

Gets the normalized rank corresponding to the given a quantile.

Specified by:

getRank in interface DoublesSortedView

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 KllDoublesSketchSortedViewIterator iterator()

Description copied from interface: SortedView

Returns an iterator for this Sorted View.

Specified by:

iterator in interface DoublesSortedView

Specified by:

iterator in interface SortedView

Returns:

an iterator for this Sorted View.