com.metamx.collections.bitmap

Interface MutableBitmap

All Superinterfaces:

ImmutableBitmap

All Known Implementing Classes:

WrappedBitSetBitmap, WrappedConciseBitmap, WrappedRoaringBitmap

public interface MutableBitmap
extends ImmutableBitmap

This class is meant to represent a simple wrapper around a bitmap class.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int entry) Add the specified integer to the bitmap.
void	and(MutableBitmap mutableBitmap) Compute the bitwise-and of this bitmap with another bitmap.
void	andNot(MutableBitmap mutableBitmap) Compute the bitwise-andNot of this bitmap with another bitmap.
void	clear() Empties the content of this bitmap.
int	getSizeInBytes() Return the size in bytes for the purpose of serialization to a ByteBuffer.
void	or(MutableBitmap mutableBitmap) Compute the bitwise-or of this bitmap with another bitmap.
void	remove(int entry) Remove the specified integer to the bitmap.
void	serialize(ByteBuffer buffer) Write out a serialized (Immutable) version of the bitmap to the ByteBuffer.
void	xor(MutableBitmap mutableBitmap) Compute the bitwise-xor of this bitmap with another bitmap.

Methods inherited from interface com.metamx.collections.bitmap.ImmutableBitmap

compareTo, difference, get, intersection, isEmpty, iterator, size, toBytes, union

Method Detail

clear

void clear()

Empties the content of this bitmap.

or

void or(MutableBitmap mutableBitmap)

Compute the bitwise-or of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Parameters:

mutableBitmap - other bitmap

and

void and(MutableBitmap mutableBitmap)

Compute the bitwise-and of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Parameters:

mutableBitmap - other bitmap

xor

void xor(MutableBitmap mutableBitmap)

Compute the bitwise-xor of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Parameters:

mutableBitmap - other bitmap

andNot

void andNot(MutableBitmap mutableBitmap)

Compute the bitwise-andNot of this bitmap with another bitmap. The current bitmap is modified whereas the other bitmap is left intact. Note that the other bitmap should be of the same class instance.

Parameters:

mutableBitmap - other bitmap

getSizeInBytes

int getSizeInBytes()

Return the size in bytes for the purpose of serialization to a ByteBuffer. Note that this is distinct from the memory usage.

Returns:

the total set in bytes

add

void add(int entry)

Add the specified integer to the bitmap. This is equivalent to setting the ith bit to the value 1.

Parameters:

entry - integer to be added

remove

void remove(int entry)

Remove the specified integer to the bitmap. This is equivalent to setting the ith bit to the value 1.

Parameters:

entry - integer to be remove

serialize

void serialize(ByteBuffer buffer)

Write out a serialized (Immutable) version of the bitmap to the ByteBuffer. We preprend the serialized bitmap with a 4-byte int indicating the size in bytes. Thus getSizeInBytes() + 4 bytes are written. (These 4 bytes are required by ConciseSet but not by RoaringBitmap. Nevertheless, we always write them for the sake of simplicity, even if it wastes 4 bytes in some instances.)

Parameters:

buffer - where we write