Package org.apache.datasketches.kll

Class KllFloatsSketchSortedViewIterator

java.lang.Object

org.apache.datasketches.kll.KllFloatsSketchSortedViewIterator

All Implemented Interfaces:

FloatsSortedViewIterator, SortedViewIterator

public final class KllFloatsSketchSortedViewIterator
extends Object
implements FloatsSortedViewIterator

Iterator over KllFloatsSketchSortedView

Author:

Alexander Saydakov, Lee Rhodes

Method Summary

Modifier and Type	Method	Description
long	getCumulativeWeight(QuantileSearchCriteria searchCrit)	Gets the cumulative weight at the current index (or previous index) based on the chosen search criterion.
long	getN()	Gets the total count of all items presented to the sketch.
double	getNormalizedRank(QuantileSearchCriteria searchCrit)	Gets the normalized rank at the current index (or previous index) based on the chosen search criterion.
float	getQuantile()	Gets the quantile at the current index.
long	getWeight()	Gets the natural weight at the current index.
boolean	next()	Advances the index and checks if it is valid.

Methods inherited from class java.lang.Object

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

Method Detail

getCumulativeWeight

public long getCumulativeWeight(QuantileSearchCriteria searchCrit)

Description copied from interface: SortedViewIterator

Gets the cumulative weight at the current index (or previous index) based on the chosen search criterion. This is also referred to as the "Natural Rank".

Don't call this before calling next() for the first time or after getting false from next().

Specified by:

getCumulativeWeight in interface SortedViewIterator

Parameters:

searchCrit - if INCLUSIVE, includes the weight at the current index in the cumulative sum. Otherwise, it will return the cumulative weight of the previous index.

Returns:

cumulative weight at the current index on the chosen search criterion.

getN

public long getN()

Description copied from interface: SortedViewIterator

Gets the total count of all items presented to the sketch.

Specified by:

getN in interface SortedViewIterator

Returns:

the total count of all items presented to the sketch.

getNormalizedRank

public double getNormalizedRank(QuantileSearchCriteria searchCrit)

Description copied from interface: SortedViewIterator

Gets the normalized rank at the current index (or previous index) based on the chosen search criterion.

Don't call this before calling next() for the first time or after getting false from next().

Specified by:

getNormalizedRank in interface SortedViewIterator

Parameters:

searchCrit - if INCLUSIVE, includes the normalized rank at the current index. Otherwise, returns the normalized rank of the previous index.

Returns:

the normalized rank at the current index (or previous index) based on the chosen search criterion.

getQuantile

public float getQuantile()

Description copied from interface: FloatsSortedViewIterator

Gets the quantile at the current index.

Don't call this before calling next() for the first time or after getting false from next().

Specified by:

getQuantile in interface FloatsSortedViewIterator

Returns:

the quantile at the current index.

getWeight

public long getWeight()

Description copied from interface: SortedViewIterator

Gets the natural weight at the current index.

Don't call this before calling next() for the first time or after getting false from next().

Specified by:

getWeight in interface SortedViewIterator

Returns:

the natural weight at the current index.

next

public boolean next()

Description copied from interface: SortedViewIterator

Advances the index and checks if it is valid. The state of this iterator is undefined before the first call of this method.

Specified by:

next in interface SortedViewIterator

Returns:

true if the next index is valid.