Module roaringbitmap

Package org.roaringbitmap.buffer

Class MutableRoaringArray

java.lang.Object

org.roaringbitmap.buffer.MutableRoaringArray

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, AppendableStorage<MappeableContainer>, PointableRoaringArray

public final class MutableRoaringArray
extends Object
implements Cloneable, Externalizable, PointableRoaringArray, AppendableStorage<MappeableContainer>

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MutableRoaringArray()
	MutableRoaringArray(int initialCapacity)

Method Summary

Modifier and Type	Method	Description
int	advanceUntil(char x, int pos)	Find the smallest integer index larger than pos such that getKeyAtIndex(index)>=x.
void	append(char key, MappeableContainer value)	Appends the key and container to the storage, throws if the key is less than the current mark.
protected void	appendCopiesAfter(PointableRoaringArray highLowContainer, char beforeStart)	Append copies of the values AFTER a specified key (may or may not be present) to end.
protected void	appendCopiesUntil(PointableRoaringArray highLowContainer, char stoppingKey)	Append copies of the values from another array, from the start
protected void	appendCopy(char key, MappeableContainer value)
protected void	appendCopy(PointableRoaringArray highLowContainer, int startingIndex, int end)	Append copies of the values from another array
protected void	clear()
MutableRoaringArray	clone()	Create an independent copy of the underlying array
boolean	containsForContainerAtIndex(int i, char x)	This checks whether the container at index i has the value x.
protected void	copyRange(int begin, int end, int newBegin)
void	deserialize(DataInput in)	Deserialize.
void	deserialize(ByteBuffer bbf)	Deserialize (retrieve) this bitmap.
boolean	equals(Object o)
protected void	extendArray(int k)
int	first()	Gets the smallest unsigned (first) integer in the array.
int	firstSigned()	Gets the smallest signed integer in the array.
int	getCardinality(int i)	Returns the cardinality of the container at the given index.
MappeableContainer	getContainerAtIndex(int i)
int	getContainerIndex(char x)	Returns either the index of the container corresponding to key x, or a negative value.
MappeableContainerPointer	getContainerPointer()
MappeableContainerPointer	getContainerPointer(int startIndex)
int	getIndex(char x)
char	getKeyAtIndex(int i)
int	hashCode()
boolean	hasRunCompression()	Check whether this bitmap has had its runs compressed.
protected int	headerSize()
protected void	insertNewKeyValueAt(int i, char key, MappeableContainer value)
int	last()	Gets the largest unsigned (last) integer in the array.
int	lastSigned()	Gets the largest signed integer in the array.
void	readExternal(ObjectInput in)
protected void	removeAtIndex(int i)
protected void	removeIndexRange(int begin, int end)
protected void	replaceKeyAndContainerAtIndex(int i, char key, MappeableContainer c)
protected void	resize(int newLength)
void	serialize(DataOutput out)	Serialize.
void	serialize(ByteBuffer buffer)	Serialize.
int	serializedSizeInBytes()	Report the number of bytes required for serialization.
protected void	setContainerAtIndex(int i, MappeableContainer c)
int	size()
void	trim()	If possible, recover wasted memory.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Details

INITIAL_CAPACITY

protected static final int INITIAL_CAPACITY

See Also:

• Constant Field Values

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 Details

MutableRoaringArray

protected MutableRoaringArray()

MutableRoaringArray

public MutableRoaringArray(int initialCapacity)

Method Details

advanceUntil

public int advanceUntil(char x,
 int pos)

Description copied from interface: PointableRoaringArray

Find the smallest integer index larger than pos such that getKeyAtIndex(index)>=x. If none can be found, return size.

Specified by:

advanceUntil in interface PointableRoaringArray

Parameters:

x - minimal value

pos - index to exceed

Returns:

the smallest index greater than pos such that getKeyAtIndex(index) is at least as large as min, or size if it is not possible.

append

public void append(char key,
 MappeableContainer value)

Description copied from interface: AppendableStorage

Appends the key and container to the storage, throws if the key is less than the current mark.

Specified by:

append in interface AppendableStorage<MappeableContainer>

Parameters:

key - the key to append

value - the data to append

appendCopiesAfter

protected void appendCopiesAfter(PointableRoaringArray highLowContainer,
 char 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,
 char 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(char key,
 MappeableContainer value)

clear

protected void clear()

trim

public void trim()

If possible, recover wasted memory.

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

copyRange

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

deserialize

public void deserialize(DataInput in)
                 throws IOException

Deserialize.

Parameters:

in - the DataInput stream

Throws:

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

deserialize

public void deserialize(ByteBuffer bbf)

Deserialize (retrieve) this bitmap. See format specification at https://github.com/RoaringBitmap/RoaringFormatSpec The current bitmap is overwritten. It is not necessary that limit() on the input ByteBuffer indicates the end of the serialized data. After loading this RoaringBitmap, you can advance to the rest of the data (if there is more) by setting bbf.position(bbf.position() + bitmap.serializedSizeInBytes()); Note that the input ByteBuffer is effectively copied (with the slice operation) so you should expect the provided ByteBuffer position/mark/limit/order to remain unchanged.

Parameters:

bbf - the byte buffer (can be mapped, direct, array backed etc.

extendArray

protected void extendArray(int k)

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

getContainerIndex

public int getContainerIndex(char x)

Description copied from interface: PointableRoaringArray

Returns either the index of the container corresponding to key x, or a negative value.

Specified by:

getContainerIndex in interface PointableRoaringArray

Parameters:

x - 16-bit key

Returns:

index of container (negative value if no container found)

getContainerAtIndex

public MappeableContainer getContainerAtIndex(int i)

Specified by:

getContainerAtIndex in interface PointableRoaringArray

Parameters:

i - index

Returns:

matching container

getContainerPointer

public MappeableContainerPointer getContainerPointer()

Specified by:

getContainerPointer in interface PointableRoaringArray

Returns:

a ContainerPointer to iterator over the array

getContainerPointer

public MappeableContainerPointer getContainerPointer(int startIndex)

Specified by:

getContainerPointer in interface PointableRoaringArray

Parameters:

startIndex - starting index

Returns:

a ContainerPointer to iterator over the array initially positioned at startIndex

getIndex

public int getIndex(char x)

Specified by:

getIndex in interface PointableRoaringArray

Parameters:

x - 16-bit key

Returns:

corresponding index

getKeyAtIndex

public char getKeyAtIndex(int i)

Specified by:

getKeyAtIndex in interface PointableRoaringArray

Parameters:

i - the index

Returns:

16-bit key at the index

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasRunCompression

public boolean hasRunCompression()

Description copied from interface: PointableRoaringArray

Check whether this bitmap has had its runs compressed.

Specified by:

hasRunCompression in interface PointableRoaringArray

Returns:

whether this bitmap has run compression

headerSize

protected int headerSize()

insertNewKeyValueAt

protected void insertNewKeyValueAt(int i,
 char 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)

removeIndexRange

protected void removeIndexRange(int begin,
 int end)

replaceKeyAndContainerAtIndex

protected void replaceKeyAndContainerAtIndex(int i,
 char key,
 MappeableContainer c)

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.

serialize

public void serialize(ByteBuffer buffer)

Serialize. The current bitmap is not modified.

Specified by:

serialize in interface PointableRoaringArray

Parameters:

buffer - the ByteBuffer to write to

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

containsForContainerAtIndex

public boolean containsForContainerAtIndex(int i,
 char x)

Description copied from interface: PointableRoaringArray

This checks whether the container at index i has the value x. This can be faster than calling "getContainerAtIndex" and then calling contains.

Specified by:

containsForContainerAtIndex in interface PointableRoaringArray

Parameters:

i - container index (assumed to be non-negative)

x - 16-bit value to check

Returns:

whether the container contains at index i contains x

first

public int first()

Description copied from interface: PointableRoaringArray

Gets the smallest unsigned (first) integer in the array.

Specified by:

first in interface PointableRoaringArray

Returns:

the smallest unsigned (first) integer in the array

last

public int last()

Description copied from interface: PointableRoaringArray

Gets the largest unsigned (last) integer in the array.

Specified by:

last in interface PointableRoaringArray

Returns:

the largest unsigned (last) integer in the array

firstSigned

public int firstSigned()

Description copied from interface: PointableRoaringArray

Gets the smallest signed integer in the array.

Specified by:

firstSigned in interface PointableRoaringArray

Returns:

the smallest signed integer in the array

lastSigned

public int lastSigned()

Description copied from interface: PointableRoaringArray

Gets the largest signed integer in the array.

Specified by:

lastSigned in interface PointableRoaringArray

Returns:

the largest signed integer in the array