Package org.apache.datasketches.quantiles

Class ItemsSketchIterator<T>

java.lang.Object

org.apache.datasketches.quantiles.ItemsSketchIterator<T>

Type Parameters:

T - type of item

public class ItemsSketchIterator<T>
extends Object

Iterator over ItemsSketch. The order is not defined.

Method Summary

Modifier and Type	Method	Description
T	getValue()	Gets a value from the current entry in the sketch.
long	getWeight()	Gets a weight for the value from the current entry in the sketch.
boolean	next()	Advancing the iterator and checking existence of the next entry is combined here for efficiency.

Methods inherited from class java.lang.Object

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

Method Details

next

public boolean next()

Advancing the iterator and checking existence of the next entry is combined here for efficiency. This results in an undefined state of the iterator before the first call of this method.

Returns:

true if the next element exists

getValue

public T getValue()

Gets a value from the current entry in the sketch. Don't call this before calling next() for the first time or after getting false from next().

Returns:

value from the current entry

getWeight

public long getWeight()

Gets a weight for the value from the current entry in the sketch. Don't call this before calling next() for the first time or after getting false from next().

Returns:

weight for the value from the current entry