org.roaringbitmap.buffer

Class MappeableBitmapContainer

java.lang.Object

org.roaringbitmap.buffer.MappeableContainer

org.roaringbitmap.buffer.MappeableBitmapContainer

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>

public final class MappeableBitmapContainer
extends MappeableContainer
implements Cloneable, Serializable

Simple bitset-like container. Unlike org.roaringbitmap.BitmapContainer, this class uses a LongBuffer to store data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_CAPACITY

Constructor Summary

Constructors

Constructor and Description
MappeableBitmapContainer() Create a bitmap container with all bits set to false
MappeableBitmapContainer(int firstOfRun, int lastOfRun) Create a bitmap container with a run of ones from firstOfRun to lastOfRun, inclusive caller must ensure that the range isn't so small that an ArrayContainer should have been created instead
MappeableBitmapContainer(LongBuffer array, int initCardinality) Construct a new BitmapContainer backed by the provided LongBuffer.

Method Summary

Modifier and Type	Method and Description
MappeableContainer	add(short i) Add a short to the container.
MappeableArrayContainer	and(MappeableArrayContainer value2) Computes the bitwise AND of this container with another (intersection).
MappeableContainer	and(MappeableBitmapContainer value2) Computes the bitwise AND of this container with another (intersection).
MappeableContainer	andNot(MappeableArrayContainer value2) Computes the bitwise ANDNOT of this container with another (difference).
MappeableContainer	andNot(MappeableBitmapContainer value2) Computes the bitwise ANDNOT of this container with another (difference).
void	clear() Empties the container
MappeableBitmapContainer	clone()
protected void	computeCardinality()
boolean	contains(short i) Checks whether the contain contains the provided value
boolean	equals(Object o)
protected void	fillArray(short[] array) Fill the array with set bits
void	fillLeastSignificant16bits(int[] x, int i, int mask) Fill the least significant 16 bits of the integer array, starting at index index, with the short values from this container.
protected int	getArraySizeInBytes() Size of the underlying array
int	getCardinality() Computes the distinct number of short values in the container.
ShortIterator	getShortIterator() Iterator to visit the short values in the container
int	getSizeInBytes() Computes an estimate of the memory usage of this container.
int	hashCode()
MappeableContainer	iand(MappeableArrayContainer b2) Computes the in-place bitwise AND of this container with another (intersection).
MappeableContainer	iand(MappeableBitmapContainer b2) Computes the in-place bitwise AND of this container with another (intersection).
MappeableContainer	iandNot(MappeableArrayContainer b2) Computes the in-place bitwise ANDNOT of this container with another (difference).
MappeableContainer	iandNot(MappeableBitmapContainer b2) Computes the in-place bitwise ANDNOT of this container with another (difference).
protected MappeableContainer	ilazyor(MappeableArrayContainer value2)
protected MappeableContainer	ilazyor(MappeableBitmapContainer x)
MappeableContainer	inot(int firstOfRange, int lastOfRange) Computes the in-place bitwise NOT of this container (complement).
MappeableBitmapContainer	ior(MappeableArrayContainer value2) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	ior(MappeableBitmapContainer b2) Computes the in-place bitwise OR of this container with another (union).
Iterator<Short>	iterator()
MappeableContainer	ixor(MappeableArrayContainer value2) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	ixor(MappeableBitmapContainer b2) Computes the in-place bitwise OR of this container with another (union).
protected MappeableContainer	lazyor(MappeableArrayContainer value2)
protected MappeableContainer	lazyor(MappeableBitmapContainer x)
MappeableContainer	limit(int maxcardinality) Create a new MappeableContainer containing at most maxcardinality integers.
protected void	loadData(MappeableArrayContainer arrayContainer)
int	nextSetBit(int i) Find the index of the next set bit greater or equal to i, returns -1 if none found.
short	nextUnsetBit(int i) Find the index of the next unset bit greater or equal to i, returns -1 if none found.
MappeableContainer	not(int firstOfRange, int lastOfRange) Computes the bitwise NOT of this container (complement).
MappeableBitmapContainer	or(MappeableArrayContainer value2) Computes the bitwise OR of this container with another (union).
MappeableContainer	or(MappeableBitmapContainer value2) Computes the bitwise OR of this container with another (union).
int	rank(short lowbits) Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()).
void	readExternal(ObjectInput in)
MappeableContainer	remove(short i) Remove the short from this container.
short	select(int j) Return the jth value
MappeableArrayContainer	toArrayContainer() Copies the data to an array container
String	toString()
void	trim() If possible, recover wasted memory.
protected void	writeArray(DataOutput out) Write just the underlying array.
void	writeExternal(ObjectOutput out)
MappeableContainer	xor(MappeableArrayContainer value2) Computes the bitwise OR of this container with another (union).
MappeableContainer	xor(MappeableBitmapContainer value2) Computes the bitwise OR of this container with another (union).

Methods inherited from class org.roaringbitmap.buffer.MappeableContainer

and, andNot, iand, iandNot, ior, ixor, lazyIOR, lazyOR, or, rangeOfOnes, xor

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

MAX_CAPACITY

protected static final int MAX_CAPACITY

See Also:

Constant Field Values

Constructor Detail

MappeableBitmapContainer

public MappeableBitmapContainer()

Create a bitmap container with all bits set to false

MappeableBitmapContainer

public MappeableBitmapContainer(int firstOfRun,
                                int lastOfRun)

Create a bitmap container with a run of ones from firstOfRun to lastOfRun, inclusive caller must ensure that the range isn't so small that an ArrayContainer should have been created instead

Parameters:

firstOfRun - first index

lastOfRun - last index (range is inclusive)

MappeableBitmapContainer

public MappeableBitmapContainer(LongBuffer array,
                                int initCardinality)

Construct a new BitmapContainer backed by the provided LongBuffer.

Parameters:

array - LongBuffer where the data is stored

initCardinality - cardinality (number of values stored)

Method Detail

add

public MappeableContainer add(short i)

Description copied from class: MappeableContainer

Add a short to the container. May generate a new container.

Specified by:

add in class MappeableContainer

Parameters:

i - short to be added

Returns:

the new container

and

public MappeableArrayContainer and(MappeableArrayContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise AND of this container with another (intersection). This container as well as the provided container are left unaffected.

Specified by:

and in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

and

public MappeableContainer and(MappeableBitmapContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise AND of this container with another (intersection). This container as well as the provided container are left unaffected.

Specified by:

and in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

andNot

public MappeableContainer andNot(MappeableArrayContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise ANDNOT of this container with another (difference). This container as well as the provided container are left unaffected.

Specified by:

andNot in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

andNot

public MappeableContainer andNot(MappeableBitmapContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise ANDNOT of this container with another (difference). This container as well as the provided container are left unaffected.

Specified by:

andNot in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

clear

public void clear()

Description copied from class: MappeableContainer

Empties the container

Specified by:

clear in class MappeableContainer

clone

public MappeableBitmapContainer clone()

Specified by:

clone in class MappeableContainer

contains

public boolean contains(short i)

Description copied from class: MappeableContainer

Checks whether the contain contains the provided value

Specified by:

contains in class MappeableContainer

Parameters:

i - value to check

Returns:

whether the value is in the container

equals

public boolean equals(Object o)

Overrides:

equals in class Object

fillArray

protected void fillArray(short[] array)

Fill the array with set bits

Parameters:

array - container (should be sufficiently large)

fillLeastSignificant16bits

public void fillLeastSignificant16bits(int[] x,
                                       int i,
                                       int mask)

Description copied from class: MappeableContainer

Fill the least significant 16 bits of the integer array, starting at index index, with the short values from this container. The caller is responsible to allocate enough room. The most significant 16 bits of each integer are given by the most significant bits of the provided mask.

Specified by:

fillLeastSignificant16bits in class MappeableContainer

Parameters:

x - provided array

i - starting index

mask - indicates most significant bits

getArraySizeInBytes

protected int getArraySizeInBytes()

Description copied from class: MappeableContainer

Size of the underlying array

Specified by:

getArraySizeInBytes in class MappeableContainer

Returns:

size in bytes

getCardinality

public int getCardinality()

Description copied from class: MappeableContainer

Computes the distinct number of short values in the container. Can be expected to run in constant time.

Specified by:

getCardinality in class MappeableContainer

Returns:

the cardinality

getShortIterator

public ShortIterator getShortIterator()

Description copied from class: MappeableContainer

Iterator to visit the short values in the container

Specified by:

getShortIterator in class MappeableContainer

Returns:

iterator

getSizeInBytes

public int getSizeInBytes()

Description copied from class: MappeableContainer

Computes an estimate of the memory usage of this container. The estimate is not meant to be exact.

Specified by:

getSizeInBytes in class MappeableContainer

Returns:

estimated memory usage in bytes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iand

public MappeableContainer iand(MappeableArrayContainer b2)

Description copied from class: MappeableContainer

Computes the in-place bitwise AND of this container with another (intersection). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

iand in class MappeableContainer

Parameters:

b2 - other container

Returns:

aggregated container

iand

public MappeableContainer iand(MappeableBitmapContainer b2)

Description copied from class: MappeableContainer

Computes the in-place bitwise AND of this container with another (intersection). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

iand in class MappeableContainer

Parameters:

b2 - other container

Returns:

aggregated container

iandNot

public MappeableContainer iandNot(MappeableArrayContainer b2)

Description copied from class: MappeableContainer

Computes the in-place bitwise ANDNOT of this container with another (difference). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

iandNot in class MappeableContainer

Parameters:

b2 - other container

Returns:

aggregated container

iandNot

public MappeableContainer iandNot(MappeableBitmapContainer b2)

Description copied from class: MappeableContainer

Computes the in-place bitwise ANDNOT of this container with another (difference). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

iandNot in class MappeableContainer

Parameters:

b2 - other container

Returns:

aggregated container

inot

public MappeableContainer inot(int firstOfRange,
                               int lastOfRange)

Description copied from class: MappeableContainer

Computes the in-place bitwise NOT of this container (complement). Only those bits within the range are affected. The current container is generally modified. May generate a new container.

Specified by:

inot in class MappeableContainer

Parameters:

firstOfRange - beginning of range (inclusive); 0 is beginning of this container.

lastOfRange - ending of range (exclusive)

Returns:

(partially) completmented container

ior

public MappeableBitmapContainer ior(MappeableArrayContainer value2)

Description copied from class: MappeableContainer

Computes the in-place bitwise OR of this container with another (union). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

ior in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

ior

public MappeableContainer ior(MappeableBitmapContainer b2)

Description copied from class: MappeableContainer

Computes the in-place bitwise OR of this container with another (union). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

ior in class MappeableContainer

Parameters:

b2 - other container

Returns:

aggregated container

iterator

public Iterator<Short> iterator()

Specified by:

iterator in interface Iterable<Short>

ixor

public MappeableContainer ixor(MappeableArrayContainer value2)

Description copied from class: MappeableContainer

Computes the in-place bitwise OR of this container with another (union). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

ixor in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

ixor

public MappeableContainer ixor(MappeableBitmapContainer b2)

Description copied from class: MappeableContainer

Computes the in-place bitwise OR of this container with another (union). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.

Specified by:

ixor in class MappeableContainer

Parameters:

b2 - other container

Returns:

aggregated container

loadData

protected void loadData(MappeableArrayContainer arrayContainer)

nextSetBit

public int nextSetBit(int i)

Find the index of the next set bit greater or equal to i, returns -1 if none found.

Parameters:

i - starting index

Returns:

index of the next set bit

nextUnsetBit

public short nextUnsetBit(int i)

Find the index of the next unset bit greater or equal to i, returns -1 if none found.

Parameters:

i - starting index

Returns:

index of the next unset bit

not

public MappeableContainer not(int firstOfRange,
                              int lastOfRange)

Description copied from class: MappeableContainer

Computes the bitwise NOT of this container (complement). Only those bits within the range are affected. The current container is left unaffected.

Specified by:

not in class MappeableContainer

Parameters:

firstOfRange - beginning of range (inclusive); 0 is beginning of this container.

lastOfRange - ending of range (exclusive)

Returns:

(partially) completmented container

or

public MappeableBitmapContainer or(MappeableArrayContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise OR of this container with another (union). This container as well as the provided container are left unaffected.

Specified by:

or in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

or

public MappeableContainer or(MappeableBitmapContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise OR of this container with another (union). This container as well as the provided container are left unaffected.

Specified by:

or in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

remove

public MappeableContainer remove(short i)

Description copied from class: MappeableContainer

Remove the short from this container. May create a new container.

Specified by:

remove in class MappeableContainer

Parameters:

i - to be removed

Returns:

New container

toArrayContainer

public MappeableArrayContainer toArrayContainer()

Copies the data to an array container

Returns:

the array container

toString

public String toString()

Overrides:

toString in class Object

trim

public void trim()

Description copied from class: MappeableContainer

If possible, recover wasted memory.

Specified by:

trim in class MappeableContainer

writeArray

protected void writeArray(DataOutput out)
                   throws IOException

Description copied from class: MappeableContainer

Write just the underlying array.

Specified by:

writeArray in class MappeableContainer

Parameters:

out - output stream

Throws:

IOException - in case of failure

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

xor

public MappeableContainer xor(MappeableArrayContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise OR of this container with another (union). This container as well as the provided container are left unaffected.

Specified by:

xor in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

xor

public MappeableContainer xor(MappeableBitmapContainer value2)

Description copied from class: MappeableContainer

Computes the bitwise OR of this container with another (union). This container as well as the provided container are left unaffected.

Specified by:

xor in class MappeableContainer

Parameters:

value2 - other container

Returns:

aggregated container

ilazyor

protected MappeableContainer ilazyor(MappeableArrayContainer value2)

ilazyor

protected MappeableContainer ilazyor(MappeableBitmapContainer x)

lazyor

protected MappeableContainer lazyor(MappeableArrayContainer value2)

lazyor

protected MappeableContainer lazyor(MappeableBitmapContainer x)

computeCardinality

protected void computeCardinality()

rank

public int rank(short lowbits)

Description copied from class: MappeableContainer

Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()).

Specified by:

rank in class MappeableContainer

Parameters:

lowbits - upper limit

Returns:

the rank

select

public short select(int j)

Description copied from class: MappeableContainer

Return the jth value

Specified by:

select in class MappeableContainer

Parameters:

j - index of the value

Returns:

the value

limit

public MappeableContainer limit(int maxcardinality)

Description copied from class: MappeableContainer

Create a new MappeableContainer containing at most maxcardinality integers.

Specified by:

limit in class MappeableContainer

Parameters:

maxcardinality - maximal cardinality

Returns:

a new bitmap with cardinality no more than maxcardinality