Top Description Methods
com.googlecode.javaewah

public Interface IteratingRLW

Known Direct Implementers
com.googlecode.javaewah.BufferedIterator, com.googlecode.javaewah.IteratingBufferedRunningLengthWord
High-level iterator over a compressed bitmap.

Method Summary

Modifier and TypeMethod and Description
public IteratingRLW

Returns:

a copy of the iterator
clone()

public void
discardFirstWords(long
the number of words to discard
x)

public void
discardLiteralWords(long
the number of words to discard
x)

Discard x literal words (assumes that there is no running word)

public void
discardRunningWords()

Discard all running words

public long

Returns:

the literal word at the given index.
getLiteralWordAt(int
where the literal word is
index)

public int

Returns:

the number of literal (non-fill) words
getNumberOfLiteralWords()

public boolean

Returns:

the bit used for the fill bits
getRunningBit()

public long

Returns:

length of the run of fill words
getRunningLength()

public boolean

Returns:

whether there is more
next()

public long

Returns:

sum of getRunningLength() and getNumberOfLiteralWords()
size()

Method Detail

cloneback to summary
public IteratingRLW clone() throws CloneNotSupportedException
Returns:IteratingRLW

a copy of the iterator

Exceptions
CloneNotSupportedException:
this should not be thrown in theory
discardFirstWordsback to summary
public void discardFirstWords(long x)
Parameters
x:long

the number of words to discard

discardLiteralWordsback to summary
public void discardLiteralWords(long x)

Discard x literal words (assumes that there is no running word)

Parameters
x:long

the number of words to discard

discardRunningWordsback to summary
public void discardRunningWords()

Discard all running words

getLiteralWordAtback to summary
public long getLiteralWordAt(int index)
Parameters
index:int

where the literal word is

Returns:long

the literal word at the given index.

getNumberOfLiteralWordsback to summary
public int getNumberOfLiteralWords()
Returns:int

the number of literal (non-fill) words

getRunningBitback to summary
public boolean getRunningBit()
Returns:boolean

the bit used for the fill bits

getRunningLengthback to summary
public long getRunningLength()
Returns:long

length of the run of fill words

nextback to summary
public boolean next()
Returns:boolean

whether there is more

sizeback to summary
public long size()
Returns:long

sum of getRunningLength() and getNumberOfLiteralWords()