com.googlecode.javaewah

Class EWAHIterator

java.lang.Object

com.googlecode.javaewah.EWAHIterator

All Implemented Interfaces:

Cloneable

public final class EWAHIterator
extends Object
implements Cloneable

The class EWAHIterator represents a special type of efficient iterator iterating over (uncompressed) words of bits. It is not meant for end users.

Since:

0.1.0

Author:

Daniel Lemire

Field Summary

Fields

Modifier and Type	Field and Description
protected int	pointer The pointer represent the location of the current running length word in the array of words (embedded in the rlw attribute).
protected RunningLengthWord	rlw The current running length word.
protected int	size The size in words.

Constructor Summary

Constructors

Constructor and Description
EWAHIterator(EWAHCompressedBitmap a, int sizeInWords) Instantiates a new EWAH iterator.

Method Summary

Modifier and Type	Method and Description
long[]	buffer() Access to the array of words
EWAHIterator	clone()
static EWAHIterator	getEWAHIterator(EWAHCompressedBitmap bitmap) Allow expert developers to instantiate an EWAHIterator.
boolean	hasNext() Checks for next.
int	literalWords() Position of the literal words represented by this running length word.
RunningLengthWord	next() Next running length word.

Methods inherited from class java.lang.Object

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

Field Detail

pointer

protected int pointer

The pointer represent the location of the current running length word in the array of words (embedded in the rlw attribute).

rlw

protected RunningLengthWord rlw

The current running length word.

size

protected int size

The size in words.

Constructor Detail

EWAHIterator

public EWAHIterator(EWAHCompressedBitmap a,
                    int sizeInWords)

Instantiates a new EWAH iterator.

Parameters:

a - the array of words

sizeInWords - the number of words that are significant in the array of words

Method Detail

getEWAHIterator

public static EWAHIterator getEWAHIterator(EWAHCompressedBitmap bitmap)

Allow expert developers to instantiate an EWAHIterator.

Parameters:

bitmap - we want to iterate over

Returns:

an iterator

buffer

public long[] buffer()

Access to the array of words

Returns:

the long[]

literalWords

public int literalWords()

Position of the literal words represented by this running length word.

Returns:

the int

hasNext

public boolean hasNext()

Checks for next.

Returns:

true, if successful

next

public RunningLengthWord next()

Next running length word.

Returns:

the running length word

clone

public EWAHIterator clone()
                   throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException