JavaEWAH 1.2.3 · com.googlecode.javaewah.IteratingBufferedRunningLengthWord

Modifier and Type	Field and Description
private BufferedRunningLengthWord	brlw
private final Buffer	buffer
private EWAHIterator	iterator
private int	literalWordStartPosition

Access	Constructor and Description
public	IteratingBufferedRunningLengthWord(final EWAHIterator iterator iterator) Instantiates a new iterating buffered running length word.
public	IteratingBufferedRunningLengthWord(final EWAHCompressedBitmap over which we want to iterate bitmap) Instantiates a new iterating buffered running length word.

Method Summary

Modifier and Type	Method and Description
public IteratingBufferedRunningLengthWord	clone() Overrides java.lang.Object.clone. Implements com.googlecode.javaewah.IteratingRLW.clone. Creates and returns a copy of this object.
public void	discardFirstWords(long the number of words to be discarded x) Implements com.googlecode.javaewah.IteratingRLW.discardFirstWords. Discard first words, iterating to the next running length word if needed.
public void	discardLiteralWords(long the number of words to discard x) Implements com.googlecode.javaewah.IteratingRLW.discardLiteralWords. Discard x literal words (assumes that there is no running word)
public void	discardRunningWords() Implements com.googlecode.javaewah.IteratingRLW.discardRunningWords. Discard all running words
public long	Returns: how many written discharge(BitmapStorage target for writes container, long maximal number of writes max) Write out up to max words, returns how many were written
public void	discharge(BitmapStorage target for writes container) Write out the remaining words
private static void	discharge(final BufferedRunningLengthWord the initial word initialWord, final EWAHIterator the iterator iterator, final BitmapStorage the container container) For internal use.
public void	dischargeAsEmpty(BitmapStorage target for writes container) Write out the remain words, transforming them to zeroes.
public long	Returns: how many written dischargeNegated(BitmapStorage target for writes container, long maximal number of writes max) Write out up to max words (negated), returns how many were written
public long	Returns: the literal word getLiteralWordAt(int zero based index index) Implements com.googlecode.javaewah.IteratingRLW.getLiteralWordAt. Get the nth literal word for the current running length word
public int	Returns: the number of literal words getNumberOfLiteralWords() Implements com.googlecode.javaewah.IteratingRLW.getNumberOfLiteralWords. Gets the number of literal words for the current running length word.
public boolean	Returns: the running bit getRunningBit() Implements com.googlecode.javaewah.IteratingRLW.getRunningBit. Gets the running bit.
public long	Returns: the running length getRunningLength() Implements com.googlecode.javaewah.IteratingRLW.getRunningLength. Gets the running length.
public boolean	Returns: whether the move was possible next() Implements com.googlecode.javaewah.IteratingRLW.next. Move to the next RunningLengthWord
public long	Returns: the long size() Implements com.googlecode.javaewah.IteratingRLW.size. Size in uncompressed words of the current running length word.
public void	writeLiteralWords(int number of words to be written numWords, BitmapStorage where we write container) write the first N literal words to the target bitmap.
public void	writeNegatedLiteralWords(int number of words to be written numWords, BitmapStorage where we write container) write the first N literal words (negated) to the target bitmap.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

brlw	back to summary
private BufferedRunningLengthWord brlw

buffer	back to summary
private final Buffer buffer

iterator	back to summary
private EWAHIterator iterator

literalWordStartPosition	back to summary
private int literalWordStartPosition

IteratingBufferedRunningLengthWord	back to summary
public IteratingBufferedRunningLengthWord(final EWAHIterator iterator) Instantiates a new iterating buffered running length word. Parameters iterator:EWAHIterator iterator

IteratingBufferedRunningLengthWord	back to summary
public IteratingBufferedRunningLengthWord(final EWAHCompressedBitmap bitmap) Instantiates a new iterating buffered running length word. Parameters bitmap:EWAHCompressedBitmap over which we want to iterate

Method Detail

clone back to summary

clone	back to summary
public IteratingBufferedRunningLengthWord clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Implements com.googlecode.javaewah.IteratingRLW.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:IteratingBufferedRunningLengthWord Doc from com.googlecode.javaewah.IteratingRLW.clone. a copy of the iterator Annotations @Override Exceptions CloneNotSupportedException: Doc from com.googlecode.javaewah.IteratingRLW.clone. this should not be thrown in theory

public IteratingBufferedRunningLengthWord clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Implements com.googlecode.javaewah.IteratingRLW.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:IteratingBufferedRunningLengthWord

Doc from com.googlecode.javaewah.IteratingRLW.clone.

a copy of the iterator

Annotations

@Override

Exceptions

CloneNotSupportedException:

Doc from com.googlecode.javaewah.IteratingRLW.clone.

this should not be thrown in theory

discardFirstWords	back to summary
public void discardFirstWords(long x) Implements com.googlecode.javaewah.IteratingRLW.discardFirstWords. Discard first words, iterating to the next running length word if needed. Parameters x:long the number of words to be discarded Annotations @Override

discardFirstWords

public final Class IteratingBufferedRunningLengthWord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail