org.roaringbitmap.buffer

Class MutableRoaringArray

java.lang.Object

org.roaringbitmap.buffer.MutableRoaringArray

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, PointableRoaringArray

public final class MutableRoaringArray
extends Object
implements Cloneable, Externalizable, PointableRoaringArray

Specialized array to store the containers used by a RoaringBitmap. This class is similar to org.roaringbitmap.RoaringArray but meant to be used with memory mapping. This is not meant to be used by end users. Objects of this class reside in RAM.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MutableRoaringArray.Element

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	INITIAL_CAPACITY
protected static short	SERIAL_COOKIE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutableRoaringArray()
protected	MutableRoaringArray(ByteBuffer bb) Create a roaring array based on a previously serialized ByteBuffer.

Method Summary

Modifier and Type	Method and Description
protected void	append(short key, MappeableContainer value)
protected void	appendCopiesAfter(PointableRoaringArray highLowContainer, short beforeStart) Append copies of the values AFTER a specified key (may or may not be present) to end.
protected void	appendCopiesUntil(PointableRoaringArray highLowContainer, short stoppingKey) Append copies of the values from another array, from the start
protected void	appendCopy(PointableRoaringArray highLowContainer, int startingIndex, int end) Append copies of the values from another array
protected void	appendCopy(short key, MappeableContainer value)
protected void	clear()
MutableRoaringArray	clone() Create an independent copy of the underlying array
void	deserialize(DataInput in) Deserialize.
boolean	equals(Object o)
protected void	extendArray(int k)
int	getCardinality(int i) Returns the cardinality of the container at the given index.
MappeableContainer	getContainer(short x)
MappeableContainer	getContainerAtIndex(int i)
org.roaringbitmap.buffer.MappeableContainerPointer	getContainerPointer()
int	getIndex(short x)
short	getKeyAtIndex(int i)
int	hashCode()
protected void	insertNewKeyValueAt(int i, short key, MappeableContainer value)
void	readExternal(ObjectInput in)
protected void	removeAtIndex(int i)
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, MappeableContainer c)
int	size()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_CAPACITY

protected static final int INITIAL_CAPACITY

See Also:

Constant Field Values

SERIAL_COOKIE

protected static final short SERIAL_COOKIE

See Also:

Constant Field Values

Constructor Detail

MutableRoaringArray

protected MutableRoaringArray()

MutableRoaringArray

protected MutableRoaringArray(ByteBuffer bb)

Create a roaring array based on a previously serialized ByteBuffer. As much as possible, the ByteBuffer is used as the backend, however if you modify the content, the result is unspecified.

Parameters:

bb - The source ByteBuffer

Method Detail

append

protected void append(short key,
                      MappeableContainer value)

appendCopiesAfter

protected void appendCopiesAfter(PointableRoaringArray highLowContainer,
                                 short beforeStart)

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

Parameters:

highLowContainer - the other array

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

appendCopiesUntil

protected void appendCopiesUntil(PointableRoaringArray highLowContainer,
                                 short stoppingKey)

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

Parameters:

highLowContainer - the other array

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

appendCopy

protected void appendCopy(PointableRoaringArray highLowContainer,
                          int startingIndex,
                          int end)

Append copies of the values from another array

Parameters:

highLowContainer - other array

startingIndex - starting index in the other array

end - last index array in the other array

appendCopy

protected void appendCopy(short key,
                          MappeableContainer value)

clear

protected void clear()

clone

public MutableRoaringArray clone()

Description copied from interface: PointableRoaringArray

Create an independent copy of the underlying array

Specified by:

clone in interface PointableRoaringArray

Overrides:

clone in class Object

Returns:

a copy

deserialize

public void deserialize(DataInput in)
                 throws IOException

Deserialize.

Parameters:

in - the DataInput stream

Throws:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

extendArray

protected void extendArray(int k)

getContainer

public MappeableContainer getContainer(short x)

Specified by:

getContainer in interface PointableRoaringArray

Parameters:

x - 16-bit key

Returns:

matching container

getContainerAtIndex

public MappeableContainer getContainerAtIndex(int i)

Specified by:

getContainerAtIndex in interface PointableRoaringArray

Parameters:

i - index

Returns:

matching container

getContainerPointer

public org.roaringbitmap.buffer.MappeableContainerPointer getContainerPointer()

Specified by:

getContainerPointer in interface PointableRoaringArray

Returns:

a ContainerPointer to iterator over the array

getIndex

public int getIndex(short x)

Specified by:

getIndex in interface PointableRoaringArray

Parameters:

x - 16-bit key

Returns:

corresponding index

getKeyAtIndex

public short getKeyAtIndex(int i)

Specified by:

getKeyAtIndex in interface PointableRoaringArray

Parameters:

i - the index

Returns:

16-bit key at the index

hashCode

public int hashCode()

Overrides:

hashCode in class Object

insertNewKeyValueAt

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

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

removeAtIndex

protected void removeAtIndex(int i)

resize

protected void resize(int newLength)

serialize

public void serialize(DataOutput out)
               throws IOException

Serialize. The current bitmap is not modified.

Specified by:

serialize in interface PointableRoaringArray

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.

Specified by:

serializedSizeInBytes in interface PointableRoaringArray

Returns:

the size in bytes

setContainerAtIndex

protected void setContainerAtIndex(int i,
                                   MappeableContainer c)

size

public int size()

Specified by:

size in interface PointableRoaringArray

Returns:

number of keys

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getCardinality

public int getCardinality(int i)

Description copied from interface: PointableRoaringArray

Returns the cardinality of the container at the given index. This method is expected to be fast.

Specified by:

getCardinality in interface PointableRoaringArray

Parameters:

i - index

Returns:

the cardinality