org.roaringbitmap.buffer

Class BufferIntIteratorFlyweight

java.lang.Object

org.roaringbitmap.buffer.BufferIntIteratorFlyweight

All Implemented Interfaces:

Cloneable, IntIterator, PeekableIntIterator

public class BufferIntIteratorFlyweight
extends Object
implements PeekableIntIterator

Fast iterator minimizing the stress on the garbage collector. You can create one reusable instance of this class and then wrap(ImmutableRoaringBitmap) For better performance, consider the ImmutableRoaringBitmap.forEach(org.roaringbitmap.IntConsumer) method.

Author:

Borislav Ivanov

Constructor Summary

Constructors

Constructor and Description
BufferIntIteratorFlyweight() Creates an instance that is not ready for iteration.
BufferIntIteratorFlyweight(ImmutableRoaringBitmap r) Creates an instance that is ready for iteration.

Method Summary

Modifier and Type	Method and Description
void	advanceIfNeeded(int minval) If needed, advance as long as the next value is smaller than minval
PeekableIntIterator	clone() Creates a copy of the iterator.
boolean	hasNext()
int	next()
int	peekNext() Look at the next value without advancing
void	wrap(ImmutableRoaringBitmap r) Prepares a bitmap for iteration

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferIntIteratorFlyweight

public BufferIntIteratorFlyweight()

Creates an instance that is not ready for iteration. You must first call wrap(ImmutableRoaringBitmap).

BufferIntIteratorFlyweight

public BufferIntIteratorFlyweight(ImmutableRoaringBitmap r)

Creates an instance that is ready for iteration.

Parameters:

r - bitmap to be iterated over

Method Detail

clone

public PeekableIntIterator clone()

Description copied from interface: PeekableIntIterator

Creates a copy of the iterator.

Specified by:

clone in interface IntIterator

Specified by:

clone in interface PeekableIntIterator

Overrides:

clone in class Object

Returns:

a clone of the current iterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface IntIterator

Returns:

whether there is another value

next

public int next()

Specified by:

next in interface IntIterator

Returns:

next integer value

wrap

public void wrap(ImmutableRoaringBitmap r)

Prepares a bitmap for iteration

Parameters:

r - bitmap to be iterated over

advanceIfNeeded

public void advanceIfNeeded(int minval)

Description copied from interface: PeekableIntIterator

If needed, advance as long as the next value is smaller than minval

Specified by:

advanceIfNeeded in interface PeekableIntIterator

Parameters:

minval - threshold

peekNext

public int peekNext()

Description copied from interface: PeekableIntIterator

Look at the next value without advancing

Specified by:

peekNext in interface PeekableIntIterator

Returns:

next value