org.roaringbitmap

Class RunContainer

java.lang.Object

org.roaringbitmap.Container

org.roaringbitmap.RunContainer

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>

public final class RunContainer
extends Container
implements Cloneable

This container takes the form of runs of consecutive values (effectively, run-length encoding). Adding and removing content from this container might make it wasteful so regular calls to "runOptimize" might be warranted.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	RunContainer() Create a container with default capacity
protected	RunContainer(ArrayContainer arr, int nbrRuns)
protected	RunContainer(BitmapContainer bc, int nbrRuns)
	RunContainer(int capacity) Create an array container with specified capacity
	RunContainer(short[] array, int numRuns) Construct a new RunContainer backed by the provided array.
protected	RunContainer(ShortIterator sIt, int nbrRuns)

Method Summary

Modifier and Type	Method and Description
Container	add(int begin, int end) Return a new container with all shorts in [begin,end) added using an unsigned interpretation.
Container	add(short k) Add a short to the container.
Container	and(ArrayContainer x) Computes the bitwise AND of this container with another (intersection).
Container	and(BitmapContainer x) Computes the bitwise AND of this container with another (intersection).
Container	and(RunContainer x) Computes the bitwise AND of this container with another (intersection).
Container	andNot(ArrayContainer x) Computes the bitwise ANDNOT of this container with another (difference).
Container	andNot(BitmapContainer x) Computes the bitwise ANDNOT of this container with another (difference).
Container	andNot(RunContainer x) Computes the bitwise ANDNOT of this container with another (difference).
void	clear() Empties the container
Container	clone()
boolean	contains(short x) Checks whether the contain contains the provided value
void	deserialize(DataInput in) Deserialize (recover) the container.
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 i, with the short values from this container.
Container	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
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()
Container	iadd(int begin, int end) Add all shorts in [begin,end) using an unsigned interpretation.
Container	iand(ArrayContainer x) Computes the in-place bitwise AND of this container with another (intersection).
Container	iand(BitmapContainer x) Computes the in-place bitwise AND of this container with another (intersection).
Container	iand(RunContainer x) Computes the in-place bitwise AND of this container with another (intersection).
Container	iandNot(ArrayContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
Container	iandNot(BitmapContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
Container	iandNot(RunContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
protected Container	ilazyor(ArrayContainer x)
Container	inot(int rangeStart, int rangeEnd) Computes the in-place bitwise NOT of this container (complement).
boolean	intersects(ArrayContainer x) Returns true if the current container intersects the other container.
boolean	intersects(BitmapContainer x) Returns true if the current container intersects the other container.
boolean	intersects(RunContainer x) Returns true if the current container intersects the other container.
Container	ior(ArrayContainer x) Computes the in-place bitwise OR of this container with another (union).
Container	ior(BitmapContainer x) Computes the in-place bitwise OR of this container with another (union).
Container	ior(RunContainer x) Computes the in-place bitwise OR of this container with another (union).
Container	iremove(int begin, int end) Remove shorts in [begin,end) using an unsigned interpretation.
protected boolean	isFull()
Iterator<Short>	iterator()
Container	ixor(ArrayContainer x) Computes the in-place bitwise XOR of this container with another (symmetric difference).
Container	ixor(BitmapContainer x) Computes the in-place bitwise XOR of this container with another (symmetric difference).
Container	ixor(RunContainer x) Computes the in-place bitwise XOR of this container with another (symmetric difference).
protected Container	lazyor(ArrayContainer x)
Container	limit(int maxcardinality) Create a new Container containing at most maxcardinality integers.
Container	not(int rangeStart, int rangeEnd) Computes the bitwise NOT of this container (complement).
Container	or(ArrayContainer x) Computes the bitwise OR of this container with another (union).
Container	or(BitmapContainer x) Computes the bitwise OR of this container with another (union).
Container	or(RunContainer 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)
Container	remove(int begin, int end) Return a new container with all shorts in [begin,end) remove using an unsigned interpretation.
Container	remove(short x) Remove the short from this container.
Container	repairAfterLazy() The output of a lazyOR or lazyIOR might be an invalid container, this should be called on it.
Container	runOptimize() Convert to Array or Bitmap container if the serialized form would be shorter.
short	select(int j) Return the jth value
void	serialize(DataOutput out) Serialize the container.
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)
Container	xor(ArrayContainer x) Computes the bitwise XOR of this container with another (symmetric difference).
Container	xor(BitmapContainer x) Computes the bitwise XOR of this container with another (symmetric difference).
Container	xor(RunContainer x) Computes the bitwise XOR of this container with another (symmetric difference).

Methods inherited from class org.roaringbitmap.Container

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

Constructor Detail

RunContainer

public RunContainer(short[] array,
                    int numRuns)

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

Parameters:

array - array where the data is stored

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

RunContainer

protected RunContainer(ShortIterator sIt,
                       int nbrRuns)

RunContainer

protected RunContainer(ArrayContainer arr,
                       int nbrRuns)

RunContainer

protected RunContainer(BitmapContainer bc,
                       int nbrRuns)

RunContainer

public RunContainer()

Create a container with default capacity

RunContainer

public RunContainer(int capacity)

Create an array container with specified capacity

Parameters:

capacity - The capacity of the container

Method Detail

toString

public String toString()

Overrides:

toString in class Object

runOptimize

public Container runOptimize()

Convert to Array or Bitmap container if the serialized form would be shorter. Exactly the same functionality as toEfficientContainer.

Specified by:

runOptimize in class Container

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 Container flip(short x)

Description copied from class: Container

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

Specified by:

flip in class Container

Parameters:

x - short to be added

Returns:

the new container

add

public Container add(short k)

Description copied from class: Container

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

Specified by:

add in class Container

Parameters:

k - short to be added

Returns:

the new container

add

public Container add(int begin,
                     int end)

Description copied from class: Container

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

Specified by:

add in class Container

Parameters:

begin - start of range (inclusive)

end - end of range (exclusive)

Returns:

the new container

and

public Container and(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

and

public Container and(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

andNot

public Container andNot(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

andNot

public Container andNot(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

clear

public void clear()

Description copied from class: Container

Empties the container

Specified by:

clear in class Container

clone

public Container clone()

Specified by:

clone in class Container

contains

public boolean contains(short x)

Description copied from class: Container

Checks whether the contain contains the provided value

Specified by:

contains in class Container

Parameters:

x - value to check

Returns:

whether the value is in the container

deserialize

public void deserialize(DataInput in)
                 throws IOException

Description copied from class: Container

Deserialize (recover) the container.

Specified by:

deserialize in class Container

Parameters:

in - the DataInput stream

Throws:

IOException - Signals that an I/O exception has occurred.

fillLeastSignificant16bits

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

Description copied from class: Container

Fill the least significant 16 bits of the integer array, starting at index i, 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 Container

Parameters:

x - provided array

i - starting index

mask - indicates most significant bits

getArraySizeInBytes

protected int getArraySizeInBytes()

Description copied from class: Container

Size of the underlying array

Specified by:

getArraySizeInBytes in class Container

Returns:

size in bytes

getCardinality

public int getCardinality()

Description copied from class: Container

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

Specified by:

getCardinality in class Container

Returns:

the cardinality

getShortIterator

public ShortIterator getShortIterator()

Description copied from class: Container

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

Specified by:

getShortIterator in class Container

Returns:

iterator

getReverseShortIterator

public ShortIterator getReverseShortIterator()

Description copied from class: Container

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

Specified by:

getReverseShortIterator in class Container

Returns:

iterator

getSizeInBytes

public int getSizeInBytes()

Description copied from class: Container

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

Specified by:

getSizeInBytes in class Container

Returns:

estimated memory usage in bytes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iand

public Container iand(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

iand

public Container iand(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

iandNot

public Container iandNot(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

iandNot

public Container iandNot(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

inot

public Container inot(int rangeStart,
                      int rangeEnd)

Description copied from class: Container

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 Container

Parameters:

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

rangeEnd - ending of range (exclusive)

Returns:

(partially) complemented container

ior

public Container ior(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

ior

public Container ior(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

ixor

public Container ixor(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

ixor

public Container ixor(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

not

public Container not(int rangeStart,
                     int rangeEnd)

Description copied from class: Container

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 Container

Parameters:

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

rangeEnd - ending of range (exclusive)

Returns:

(partially) complemented container

or

public Container or(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

ilazyor

protected Container ilazyor(ArrayContainer x)

lazyor

protected Container lazyor(ArrayContainer x)

isFull

protected boolean isFull()

or

public Container or(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

remove

public Container remove(short x)

Description copied from class: Container

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

Specified by:

remove in class Container

Parameters:

x - to be removed

Returns:

New container

serialize

public void serialize(DataOutput out)
               throws IOException

Description copied from class: Container

Serialize the container.

Specified by:

serialize in class Container

Parameters:

out - the DataOutput stream

Throws:

IOException - Signals that an I/O exception has occurred.

serializedSizeInBytes

public int serializedSizeInBytes()

Description copied from class: Container

Report the number of bytes required to serialize this container.

Specified by:

serializedSizeInBytes in class Container

Returns:

the size in bytes

serializedSizeInBytes

protected static int serializedSizeInBytes(int numberOfRuns)

trim

public void trim()

Description copied from class: Container

If possible, recover wasted memory.

Specified by:

trim in class Container

writeArray

protected void writeArray(DataOutput out)
                   throws IOException

Description copied from class: Container

Write just the underlying array.

Specified by:

writeArray in class Container

Parameters:

out - output stream

Throws:

IOException - in case of failure

xor

public Container xor(ArrayContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

xor

public Container xor(BitmapContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

rank

public int rank(short lowbits)

Description copied from class: Container

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

Specified by:

rank in class Container

Parameters:

lowbits - upper limit

Returns:

the rank

select

public short select(int j)

Description copied from class: Container

Return the jth value

Specified by:

select in class Container

Parameters:

j - index of the value

Returns:

the value

limit

public Container limit(int maxcardinality)

Description copied from class: Container

Create a new Container containing at most maxcardinality integers.

Specified by:

limit in class Container

Parameters:

maxcardinality - maximal cardinality

Returns:

a new bitmap with cardinality no more than maxcardinality

iadd

public Container iadd(int begin,
                      int end)

Description copied from class: Container

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

Specified by:

iadd in class Container

Parameters:

begin - start of range (inclusive)

end - end of range (exclusive)

Returns:

the new container

iremove

public Container iremove(int begin,
                         int end)

Description copied from class: Container

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

Specified by:

iremove in class Container

Parameters:

begin - start of range (inclusive)

end - end of range (exclusive)

Returns:

the new container

remove

public Container remove(int begin,
                        int end)

Description copied from class: Container

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

Specified by:

remove in class Container

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 Container and(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

andNot

public Container andNot(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

iand

public Container iand(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

iandNot

public Container iandNot(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

ior

public Container ior(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

ixor

public Container ixor(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

or

public Container or(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

xor

public Container xor(RunContainer x)

Description copied from class: Container

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 Container

Parameters:

x - other container

Returns:

aggregated container

repairAfterLazy

public Container repairAfterLazy()

Description copied from class: Container

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

Specified by:

repairAfterLazy in class Container

Returns:

a new valid container

intersects

public boolean intersects(ArrayContainer x)

Description copied from class: Container

Returns true if the current container intersects the other container.

Specified by:

intersects in class Container

Parameters:

x - other container

Returns:

whether they intersect

intersects

public boolean intersects(BitmapContainer x)

Description copied from class: Container

Returns true if the current container intersects the other container.

Specified by:

intersects in class Container

Parameters:

x - other container

Returns:

whether they intersect

intersects

public boolean intersects(RunContainer x)

Description copied from class: Container

Returns true if the current container intersects the other container.

Specified by:

intersects in class Container

Parameters:

x - other container

Returns:

whether they intersect