org.apache.paimon.utils

Class OptimizedRoaringBitmap64

java.lang.Object

org.apache.paimon.utils.OptimizedRoaringBitmap64

public class OptimizedRoaringBitmap64
extends Object

A bitmap that supports positive 64-bit positions (the most significant bit must be 0), but is optimized for cases where most positions fit in 32 bits by using an array of 32-bit Roaring bitmaps. The internal bitmap array is grown as needed to accommodate the largest position.

Mostly copied from iceberg.

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_VALUE

Constructor Summary

Constructors

Constructor and Description
OptimizedRoaringBitmap64()

Method Summary

Modifier and Type	Method and Description
void	add(long pos) Sets a position in the bitmap.
void	addRange(long posStartInclusive, long posEndExclusive) Sets a range of positions in the bitmap.
long	cardinality() Returns the number of set positions in the bitmap.
boolean	contains(long pos) Checks if a position is set in the bitmap.
static OptimizedRoaringBitmap64	deserialize(ByteBuffer buffer) Deserializes a bitmap from a buffer, assuming the portable serialization format.
void	forEach(java.util.function.LongConsumer consumer) Iterates over all positions in the bitmap.
static OptimizedRoaringBitmap64	fromRoaringBitmap32(RoaringBitmap32 roaringBitmap32)
boolean	isEmpty() Indicates whether the bitmap has any positions set.
void	or(OptimizedRoaringBitmap64 that) Sets all positions from the other bitmap in this bitmap, modifying this bitmap in place.
boolean	runLengthEncode() Applies run-length encoding wherever it is more space efficient.
void	serialize(ByteBuffer buffer) Serializes the bitmap using the portable serialization format described below.
long	serializedSizeInBytes() Returns the number of bytes required to serialize the bitmap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_VALUE

public static final long MAX_VALUE

Constructor Detail

OptimizedRoaringBitmap64

public OptimizedRoaringBitmap64()

Method Detail

fromRoaringBitmap32

public static OptimizedRoaringBitmap64 fromRoaringBitmap32(RoaringBitmap32 roaringBitmap32)

add

public void add(long pos)

Sets a position in the bitmap.

Parameters:

pos - the position

addRange

public void addRange(long posStartInclusive,
                     long posEndExclusive)

Sets a range of positions in the bitmap.

Parameters:

posStartInclusive - the start position of the range (inclusive)

posEndExclusive - the end position of the range (exclusive)

or

public void or(OptimizedRoaringBitmap64 that)

Sets all positions from the other bitmap in this bitmap, modifying this bitmap in place.

Parameters:

that - the other bitmap

contains

public boolean contains(long pos)

Checks if a position is set in the bitmap.

Parameters:

pos - the position

Returns:

true if the position is set in this bitmap, false otherwise

isEmpty

public boolean isEmpty()

Indicates whether the bitmap has any positions set.

Returns:

true if the bitmap is empty, false otherwise

cardinality

public long cardinality()

Returns the number of set positions in the bitmap.

Returns:

the number of set positions

runLengthEncode

public boolean runLengthEncode()

Applies run-length encoding wherever it is more space efficient.

Returns:

whether the bitmap was changed

forEach

public void forEach(java.util.function.LongConsumer consumer)

Iterates over all positions in the bitmap.

Parameters:

consumer - a consumer for positions

serializedSizeInBytes

public long serializedSizeInBytes()

Returns the number of bytes required to serialize the bitmap.

Returns:

the serialized size in bytes

serialize

public void serialize(ByteBuffer buffer)

Serializes the bitmap using the portable serialization format described below.

• The number of 32-bit Roaring bitmaps, serialized as 8 bytes
• For each 32-bit Roaring bitmap, ordered by unsigned comparison of the 32-bit keys:
  • The key stored as 4 bytes
  • Serialized 32-bit Roaring bitmap using the standard format

Note the byte order of the buffer must be little-endian.

Parameters:

buffer - the buffer to write to

See Also:

Roaring bitmap spec

deserialize

public static OptimizedRoaringBitmap64 deserialize(ByteBuffer buffer)

Deserializes a bitmap from a buffer, assuming the portable serialization format.

Parameters:

buffer - the buffer to read from

Returns:

a new bitmap instance with the deserialized data