org.roaringbitmap

Class RoaringArray

java.lang.Object

org.roaringbitmap.RoaringArray

All Implemented Interfaces:

Externalizable, Serializable, Cloneable

public final class RoaringArray
extends Object
implements Cloneable, Externalizable

Specialized array to store the containers used by a RoaringBitmap. This is not meant to be used by end users.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	NO_OFFSET_THRESHOLD
protected static short	SERIAL_COOKIE
protected static short	SERIAL_COOKIE_NO_RUNCONTAINER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RoaringArray()

Method Summary

Modifier and Type	Method and Description
protected int	advanceUntil(short x, int pos) Find the smallest integer index larger than pos such that array[index].key>=x.
protected void	append(short key, Container value)
protected void	appendCopiesAfter(RoaringArray sa, short beforeStart) Append copies of the values AFTER a specified key (may or may not be present) to end.
protected void	appendCopiesUntil(RoaringArray sourceArray, short stoppingKey) Append copies of the values from another array, from the start
protected void	appendCopy(RoaringArray sa, int index) Append copy of the one value from another array
protected void	appendCopy(RoaringArray sa, int startingIndex, int end) Append copies of the values from another array
protected void	clear()
RoaringArray	clone()
protected void	copyRange(int begin, int end, int newBegin)
void	deserialize(DataInput in) Deserialize.
boolean	equals(Object o)
protected void	extendArray(int k)
protected Container	getContainer(short x)
protected Container	getContainerAtIndex(int i)
protected org.roaringbitmap.ContainerPointer	getContainerPointer()
protected int	getIndex(short x)
protected short	getKeyAtIndex(int i)
int	hashCode()
protected int	headerSize()
protected void	insertNewKeyValueAt(int i, short key, Container value)
void	readExternal(ObjectInput in)
protected void	removeAtIndex(int i)
protected void	removeIndexRange(int begin, int end)
protected void	replaceKeyAndContainerAtIndex(int i, short key, Container c)
protected void	resize(int newLength)
void	serialize(DataOutput out) Serialize.
int	serializedSizeInBytes() Report the number of bytes required for serialization.
protected void	setContainerAtIndex(int i, Container c)
protected int	size()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERIAL_COOKIE_NO_RUNCONTAINER

protected static final short SERIAL_COOKIE_NO_RUNCONTAINER

See Also:

Constant Field Values

SERIAL_COOKIE

protected static final short SERIAL_COOKIE

See Also:

Constant Field Values

NO_OFFSET_THRESHOLD

protected static final int NO_OFFSET_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

RoaringArray

protected RoaringArray()

Method Detail

append

protected void append(short key,
                      Container value)

appendCopy

protected void appendCopy(RoaringArray sa,
                          int index)

Append copy of the one value from another array

Parameters:

sa - other array

index - index in the other array

appendCopy

protected void appendCopy(RoaringArray sa,
                          int startingIndex,
                          int end)

Append copies of the values from another array

Parameters:

sa - other array

startingIndex - starting index in the other array

end - endingIndex (exclusive) in the other array

appendCopiesUntil

protected void appendCopiesUntil(RoaringArray sourceArray,
                                 short stoppingKey)

Append copies of the values from another array, from the start

Parameters:

sourceArray - The array to copy from

stoppingKey - any equal or larger key in other array will terminate copying

appendCopiesAfter

protected void appendCopiesAfter(RoaringArray sa,
                                 short beforeStart)

Append copies of the values AFTER a specified key (may or may not be present) to end.

Parameters:

sa - other array

beforeStart - given key is the largest key that we won't copy

clear

protected void clear()

clone

public RoaringArray clone()
                   throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

extendArray

protected void extendArray(int k)

getContainer

protected Container getContainer(short x)

getContainerAtIndex

protected Container getContainerAtIndex(int i)

getIndex

protected int getIndex(short x)

advanceUntil

protected int advanceUntil(short x,
                           int pos)

Find the smallest integer index larger than pos such that array[index].key>=x. If none can be found, return size. Based on code by O. Kaser.

Parameters:

x - minimal value

pos - index to exceed

Returns:

the smallest index greater than pos such that array[index].key is at least as large as min, or size if it is not possible.

getKeyAtIndex

protected short getKeyAtIndex(int i)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

insertNewKeyValueAt

protected void insertNewKeyValueAt(int i,
                                   short key,
                                   Container value)

resize

protected void resize(int newLength)

removeAtIndex

protected void removeAtIndex(int i)

removeIndexRange

protected void removeIndexRange(int begin,
                                int end)

copyRange

protected void copyRange(int begin,
                         int end,
                         int newBegin)

setContainerAtIndex

protected void setContainerAtIndex(int i,
                                   Container c)

replaceKeyAndContainerAtIndex

protected void replaceKeyAndContainerAtIndex(int i,
                                             short key,
                                             Container c)

size

protected int size()

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

serialize

public void serialize(DataOutput out)
               throws IOException

Serialize. The current bitmap is not modified.

Parameters:

out - the DataOutput stream

Throws:

IOException - Signals that an I/O exception has occurred.

serializedSizeInBytes

public int serializedSizeInBytes()

Report the number of bytes required for serialization.

Returns:

the size in bytes

headerSize

protected int headerSize()

deserialize

public void deserialize(DataInput in)
                 throws IOException

Deserialize.

Parameters:

in - the DataInput stream

Throws:

IOException - Signals that an I/O exception has occurred.

getContainerPointer

protected org.roaringbitmap.ContainerPointer getContainerPointer()