org.roaringbitmap.buffer

Class MappeableRunContainer

java.lang.Object

org.roaringbitmap.buffer.MappeableContainer

org.roaringbitmap.buffer.MappeableRunContainer

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>

public final class MappeableRunContainer
extends MappeableContainer
implements Cloneable

This container takes the form of runs of consecutive values (effectively, run-length encoding). Uses a ShortBuffer to store data, unlike org.roaringbitmap.RunContainer. Otherwise similar. Adding and removing content from this container might make it wasteful so regular calls to "runOptimize" might be warranted.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	nbrruns
protected ShortBuffer	valueslength

Constructor Summary

Constructors

Modifier	Constructor and Description
	MappeableRunContainer() Create a container with default capacity
	MappeableRunContainer(int capacity) Create an array container with specified capacity
protected	MappeableRunContainer(MappeableArrayContainer arr, int nbrRuns)
protected	MappeableRunContainer(MappeableBitmapContainer bc, int nbrRuns)
	MappeableRunContainer(ShortBuffer array, int numRuns) Construct a new RunContainer backed by the provided ShortBuffer.
protected	MappeableRunContainer(ShortIterator sIt, int nbrRuns)

Method Summary

Modifier and Type	Method and Description
MappeableContainer	add(int begin, int end) Return a new container with all shorts in [begin,end) added using an unsigned interpretation.
MappeableContainer	add(short k) Add a short to the container.
MappeableContainer	and(MappeableArrayContainer x) Computes the bitwise AND of this container with another (intersection).
MappeableContainer	and(MappeableBitmapContainer x) Computes the bitwise AND of this container with another (intersection).
MappeableContainer	and(MappeableRunContainer x) Computes the bitwise AND of this container with another (intersection).
MappeableContainer	andNot(MappeableArrayContainer x) Computes the bitwise ANDNOT of this container with another (difference).
MappeableContainer	andNot(MappeableBitmapContainer x) Computes the bitwise ANDNOT of this container with another (difference).
MappeableContainer	andNot(MappeableRunContainer x) Computes the bitwise ANDNOT of this container with another (difference).
void	clear() Empties the container
MappeableContainer	clone()
boolean	contains(short x) Checks whether the contain contains the provided value
protected void	ensureCapacity(int minNbRuns)
boolean	equals(Object o)
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.
MappeableContainer	flip(short x) Add a short to the container if it is not present, otherwise remove it.
protected int	getArraySizeInBytes() Size of the underlying array
protected static int	getArraySizeInBytes(int nbrruns)
int	getCardinality() Computes the distinct number of short values in the container.
ShortIterator	getReverseShortIterator() Iterator to visit the short values in the container in descending order.
ShortIterator	getShortIterator() Iterator to visit the short values in the container in ascending order.
int	getSizeInBytes() Computes an estimate of the memory usage of this container.
int	hashCode()
MappeableContainer	iadd(int begin, int end) Add all shorts in [begin,end) using an unsigned interpretation.
MappeableContainer	iand(MappeableArrayContainer x) Computes the in-place bitwise AND of this container with another (intersection).
MappeableContainer	iand(MappeableBitmapContainer x) Computes the in-place bitwise AND of this container with another (intersection).
MappeableContainer	iand(MappeableRunContainer x) Computes the in-place bitwise AND of this container with another (intersection).
MappeableContainer	iandNot(MappeableArrayContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
MappeableContainer	iandNot(MappeableBitmapContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
MappeableContainer	iandNot(MappeableRunContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
protected MappeableContainer	ilazyor(MappeableArrayContainer x)
MappeableContainer	inot(int rangeStart, int rangeEnd) Computes the in-place bitwise NOT of this container (complement).
boolean	intersects(MappeableArrayContainer x) Returns true if the current container intersects the other container.
boolean	intersects(MappeableBitmapContainer x) Returns true if the current container intersects the other container.
boolean	intersects(MappeableRunContainer x) Returns true if the current container intersects the other container.
MappeableContainer	ior(MappeableArrayContainer x) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	ior(MappeableBitmapContainer x) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	ior(MappeableRunContainer x) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	iremove(int begin, int end) Remove shorts in [begin,end) using an unsigned interpretation.
protected boolean	isArrayBacked()
protected boolean	isFull()
Iterator<Short>	iterator()
MappeableContainer	ixor(MappeableArrayContainer x) Computes the in-place bitwise XOR of this container with another (symmetric difference).
MappeableContainer	ixor(MappeableBitmapContainer x) Computes the in-place bitwise XOR of this container with another (symmetric difference).
MappeableContainer	ixor(MappeableRunContainer x) Computes the in-place bitwise XOR of this container with another (symmetric difference).
protected MappeableContainer	lazyor(MappeableArrayContainer x)
MappeableContainer	limit(int maxcardinality) Create a new MappeableContainer containing at most maxcardinality integers.
MappeableContainer	not(int rangeStart, int rangeEnd) Computes the bitwise NOT of this container (complement).
MappeableContainer	or(MappeableArrayContainer x) Computes the bitwise OR of this container with another (union).
MappeableContainer	or(MappeableBitmapContainer x) Computes the bitwise OR of this container with another (union).
MappeableContainer	or(MappeableRunContainer x) 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(int begin, int end) Return a new container with all shorts in [begin,end) remove using an unsigned interpretation.
MappeableContainer	remove(short x) Remove the short from this container.
MappeableContainer	repairAfterLazy() The output of a lazyOR or lazyIOR might be an invalid container, this should be called on it.
MappeableContainer	runOptimize() Convert to Array or Bitmap container if the serialized form would be shorter
short	select(int j) Return the jth value
int	serializedSizeInBytes() Report the number of bytes required to serialize this container.
protected static int	serializedSizeInBytes(int numberOfRuns)
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 x) Computes the bitwise XOR of this container with another (symmetric difference).
MappeableContainer	xor(MappeableBitmapContainer x) Computes the bitwise XOR of this container with another (symmetric difference).
MappeableContainer	xor(MappeableRunContainer x) Computes the bitwise XOR of this container with another (symmetric difference).

Methods inherited from class org.roaringbitmap.buffer.MappeableContainer

and, andNot, getContainerName, iand, iandNot, intersects, 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

valueslength

protected ShortBuffer valueslength

nbrruns

protected int nbrruns

Constructor Detail

MappeableRunContainer

public MappeableRunContainer(ShortBuffer array,
                             int numRuns)

Construct a new RunContainer backed by the provided ShortBuffer. Note that if you modify the RunContainer a new ShortBuffer may be produced.

Parameters:

array - ShortBuffer where the data is stored

numRuns - number of runs (each using 2 shorts in the buffer)

MappeableRunContainer

protected MappeableRunContainer(ShortIterator sIt,
                                int nbrRuns)

MappeableRunContainer

protected MappeableRunContainer(MappeableArrayContainer arr,
                                int nbrRuns)

MappeableRunContainer

protected MappeableRunContainer(MappeableBitmapContainer bc,
                                int nbrRuns)

MappeableRunContainer

public MappeableRunContainer()

Create a container with default capacity

MappeableRunContainer

public MappeableRunContainer(int capacity)

Create an array container with specified capacity

Parameters:

capacity - The capacity of the container

Method Detail

runOptimize

public MappeableContainer runOptimize()

Convert to Array or Bitmap container if the serialized form would be shorter

Specified by:

runOptimize in class MappeableContainer

Returns:

the new container

ensureCapacity

protected void ensureCapacity(int minNbRuns)

iterator

public Iterator<Short> iterator()

Specified by:

iterator in interface Iterable<Short>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

flip

public MappeableContainer flip(short x)

Description copied from class: MappeableContainer

Add a short to the container if it is not present, otherwise remove it. May generate a new container.

Specified by:

flip in class MappeableContainer

Parameters:

x - short to be added

Returns:

the new container

add

public MappeableContainer add(short k)

Description copied from class: MappeableContainer

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

Specified by:

add in class MappeableContainer

Parameters:

k - short to be added

Returns:

the new container

add

public MappeableContainer add(int begin,
                              int end)

Description copied from class: MappeableContainer

Return a new container with all shorts in [begin,end) added using an unsigned interpretation.

Specified by:

add in class MappeableContainer

Parameters:

begin - start of range (inclusive)

end - end of range (exclusive)

Returns:

the new container

and

public MappeableContainer and(MappeableArrayContainer x)

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:

x - other container

Returns:

aggregated container

and

public MappeableContainer and(MappeableBitmapContainer x)

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:

x - other container

Returns:

aggregated container

andNot

public MappeableContainer andNot(MappeableBitmapContainer x)

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:

x - other container

Returns:

aggregated container

andNot

public MappeableContainer andNot(MappeableArrayContainer x)

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:

x - 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 MappeableContainer clone()

Specified by:

clone in class MappeableContainer

contains

public boolean contains(short x)

Description copied from class: MappeableContainer

Checks whether the contain contains the provided value

Specified by:

contains in class MappeableContainer

Parameters:

x - value to check

Returns:

whether the value is in the container

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

getArraySizeInBytes

protected static int getArraySizeInBytes(int nbrruns)

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 in ascending order.

Specified by:

getShortIterator in class MappeableContainer

Returns:

iterator

getReverseShortIterator

public ShortIterator getReverseShortIterator()

Description copied from class: MappeableContainer

Iterator to visit the short values in the container in descending order.

Specified by:

getReverseShortIterator 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 x)

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:

x - other container

Returns:

aggregated container

iand

public MappeableContainer iand(MappeableBitmapContainer x)

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:

x - other container

Returns:

aggregated container

iandNot

public MappeableContainer iandNot(MappeableArrayContainer x)

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:

x - other container

Returns:

aggregated container

iandNot

public MappeableContainer iandNot(MappeableBitmapContainer x)

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:

x - other container

Returns:

aggregated container

inot

public MappeableContainer inot(int rangeStart,
                               int rangeEnd)

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:

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

rangeEnd - ending of range (exclusive)

Returns:

(partially) completmented container

ior

public MappeableContainer ior(MappeableArrayContainer x)

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:

x - other container

Returns:

aggregated container

ior

public MappeableContainer ior(MappeableBitmapContainer x)

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:

x - other container

Returns:

aggregated container

ixor

public MappeableContainer ixor(MappeableArrayContainer x)

Description copied from class: MappeableContainer

Computes the in-place bitwise XOR of this container with another (symmetric difference). 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:

x - other container

Returns:

aggregated container

ixor

public MappeableContainer ixor(MappeableBitmapContainer x)

Description copied from class: MappeableContainer

Computes the in-place bitwise XOR of this container with another (symmetric difference). 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:

x - other container

Returns:

aggregated container

not

public MappeableContainer not(int rangeStart,
                              int rangeEnd)

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:

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

rangeEnd - ending of range (exclusive)

Returns:

(partially) completmented container

or

public MappeableContainer or(MappeableArrayContainer x)

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:

x - other container

Returns:

aggregated container

isFull

protected boolean isFull()

ilazyor

protected MappeableContainer ilazyor(MappeableArrayContainer x)

lazyor

protected MappeableContainer lazyor(MappeableArrayContainer x)

or

public MappeableContainer or(MappeableBitmapContainer x)

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:

x - other container

Returns:

aggregated container

remove

public MappeableContainer remove(short x)

Description copied from class: MappeableContainer

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

Specified by:

remove in class MappeableContainer

Parameters:

x - to be removed

Returns:

New container

serializedSizeInBytes

public int serializedSizeInBytes()

Description copied from class: MappeableContainer

Report the number of bytes required to serialize this container.

Specified by:

serializedSizeInBytes in class MappeableContainer

Returns:

the size in bytes

serializedSizeInBytes

protected static int serializedSizeInBytes(int numberOfRuns)

trim

public void trim()

Description copied from class: MappeableContainer

If possible, recover wasted memory.

Specified by:

trim in class MappeableContainer

isArrayBacked

protected boolean isArrayBacked()

Specified by:

isArrayBacked 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

xor

public MappeableContainer xor(MappeableArrayContainer x)

Description copied from class: MappeableContainer

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

Specified by:

xor in class MappeableContainer

Parameters:

x - other container

Returns:

aggregated container

xor

public MappeableContainer xor(MappeableBitmapContainer x)

Description copied from class: MappeableContainer

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

Specified by:

xor in class MappeableContainer

Parameters:

x - other container

Returns:

aggregated container

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

iadd

public MappeableContainer iadd(int begin,
                               int end)

Description copied from class: MappeableContainer

Add all shorts in [begin,end) using an unsigned interpretation. May generate a new container.

Specified by:

iadd in class MappeableContainer

Parameters:

begin - start of range (inclusive)

end - end of range (exclusive)

Returns:

the new container

iremove

public MappeableContainer iremove(int begin,
                                  int end)

Description copied from class: MappeableContainer

Remove shorts in [begin,end) using an unsigned interpretation. May generate a new container.

Specified by:

iremove in class MappeableContainer

Parameters:

begin - start of range (inclusive)

end - end of range (exclusive)

Returns:

the new container

remove

public MappeableContainer remove(int begin,
                                 int end)

Description copied from class: MappeableContainer

Return a new container with all shorts in [begin,end) remove using an unsigned interpretation.

Specified by:

remove in class MappeableContainer

Parameters:

begin - start of range (inclusive)

end - end of range (exclusive)

Returns:

the new container

equals

public boolean equals(Object o)

Overrides:

equals in class Object

and

public MappeableContainer and(MappeableRunContainer x)

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:

x - other container

Returns:

aggregated container

andNot

public MappeableContainer andNot(MappeableRunContainer x)

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:

x - other container

Returns:

aggregated container

iand

public MappeableContainer iand(MappeableRunContainer x)

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:

x - other container

Returns:

aggregated container

iandNot

public MappeableContainer iandNot(MappeableRunContainer x)

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:

x - other container

Returns:

aggregated container

ior

public MappeableContainer ior(MappeableRunContainer x)

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:

x - other container

Returns:

aggregated container

ixor

public MappeableContainer ixor(MappeableRunContainer x)

Description copied from class: MappeableContainer

Computes the in-place bitwise XOR of this container with another (symmetric difference). 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:

x - other container

Returns:

aggregated container

toString

public String toString()

Overrides:

toString in class Object

or

public MappeableContainer or(MappeableRunContainer x)

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:

x - other container

Returns:

aggregated container

xor

public MappeableContainer xor(MappeableRunContainer x)

Description copied from class: MappeableContainer

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

Specified by:

xor in class MappeableContainer

Parameters:

x - other parameter

Returns:

aggregated container

repairAfterLazy

public MappeableContainer repairAfterLazy()

Description copied from class: MappeableContainer

The output of a lazyOR or lazyIOR might be an invalid container, this should be called on it.

Specified by:

repairAfterLazy in class MappeableContainer

Returns:

a new valid container

intersects

public boolean intersects(MappeableArrayContainer x)

Description copied from class: MappeableContainer

Returns true if the current container intersects the other container.

Specified by:

intersects in class MappeableContainer

Parameters:

x - other container

Returns:

whether they intersect

intersects

public boolean intersects(MappeableBitmapContainer x)

Description copied from class: MappeableContainer

Returns true if the current container intersects the other container.

Specified by:

intersects in class MappeableContainer

Parameters:

x - other container

Returns:

whether they intersect

intersects

public boolean intersects(MappeableRunContainer x)

Description copied from class: MappeableContainer

Returns true if the current container intersects the other container.

Specified by:

intersects in class MappeableContainer

Parameters:

x - other container

Returns:

whether they intersect