org.roaringbitmap.buffer

Class ImmutableRoaringArray

java.lang.Object

org.roaringbitmap.buffer.ImmutableRoaringArray

All Implemented Interfaces:

Cloneable, PointableRoaringArray

public final class ImmutableRoaringArray
extends Object
implements PointableRoaringArray

This is the underlying data structure for an ImmutableRoaringBitmap. This class is not meant for end-users.

Field Summary

Fields

Modifier and Type	Field and Description
protected static short	SERIAL_COOKIE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmutableRoaringArray(ByteBuffer bbf) Create an array based on a previously serialized ByteBuffer.

Method Summary

Modifier and Type	Method and Description
ImmutableRoaringArray	clone() Create an independent copy of the underlying array
boolean	equals(Object o)
int	getCardinality(int k) Returns the cardinality of the container at the given index.
MappeableContainer	getContainer(short x)
MappeableContainer	getContainerAtIndex(int i)
org.roaringbitmap.buffer.MappeableContainerPointer	getContainerPointer()
org.roaringbitmap.buffer.MappeableContainerPointer	getContainerPointer(int startIndex)
int	getIndex(short x)
short	getKeyAtIndex(int i)
int	hashCode()
void	serialize(DataOutput out) Serialize.
int	serializedSizeInBytes()
int	size()
protected int	unsignedBinarySearch(short k)

Methods inherited from class java.lang.Object

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

Field Detail

SERIAL_COOKIE

protected static final short SERIAL_COOKIE

See Also:

Constant Field Values

Constructor Detail

ImmutableRoaringArray

protected ImmutableRoaringArray(ByteBuffer bbf)

Create an array based on a previously serialized ByteBuffer.

Parameters:

bbf - The source ByteBuffer

Method Detail

unsignedBinarySearch

protected int unsignedBinarySearch(short k)

clone

public ImmutableRoaringArray 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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getCardinality

public int getCardinality(int k)

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:

k - index

Returns:

the cardinality

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

getContainerPointer

public org.roaringbitmap.buffer.MappeableContainerPointer getContainerPointer(int startIndex)

Specified by:

getContainerPointer in interface PointableRoaringArray

Returns:

a ContainerPointer to iterator over the array initially positioned at startIndex

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

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()

Specified by:

serializedSizeInBytes in interface PointableRoaringArray

Returns:

the size that the data structure occupies on disk

size

public int size()

Specified by:

size in interface PointableRoaringArray

Returns:

number of keys