org.roaringbitmap.buffer

Class MappeableContainer

java.lang.Object

org.roaringbitmap.buffer.MappeableContainer

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>

Direct Known Subclasses:

MappeableArrayContainer, MappeableBitmapContainer

public abstract class MappeableContainer
extends Object
implements Iterable<Short>, Cloneable, Externalizable

Base container class. This class is similar to org.roaringbitmap.Container but meant to be used with memory mapping.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MappeableContainer()

Method Summary

Modifier and Type	Method and Description
abstract MappeableContainer	add(short x) Add a short to the container.
abstract MappeableContainer	and(MappeableArrayContainer x) Computes the bitwise AND of this container with another (intersection).
abstract MappeableContainer	and(MappeableBitmapContainer x) Computes the bitwise AND of this container with another (intersection).
MappeableContainer	and(MappeableContainer x) Computes the bitwise AND of this container with another (intersection).
abstract MappeableContainer	andNot(MappeableArrayContainer x) Computes the bitwise ANDNOT of this container with another (difference).
abstract MappeableContainer	andNot(MappeableBitmapContainer x) Computes the bitwise ANDNOT of this container with another (difference).
MappeableContainer	andNot(MappeableContainer x) Computes the bitwise ANDNOT of this container with another (difference).
abstract void	clear() Empties the container
abstract MappeableContainer	clone()
abstract boolean	contains(short x) Checks whether the contain contains the provided value
abstract 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 abstract int	getArraySizeInBytes() Size of the underlying array
abstract int	getCardinality() Computes the distinct number of short values in the container.
abstract ShortIterator	getShortIterator() Iterator to visit the short values in the container
abstract int	getSizeInBytes() Computes an estimate of the memory usage of this container.
abstract MappeableContainer	iand(MappeableArrayContainer x) Computes the in-place bitwise AND of this container with another (intersection).
abstract MappeableContainer	iand(MappeableBitmapContainer x) Computes the in-place bitwise AND of this container with another (intersection).
MappeableContainer	iand(MappeableContainer x) Computes the in-place bitwise AND of this container with another (intersection).
abstract MappeableContainer	iandNot(MappeableArrayContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
abstract MappeableContainer	iandNot(MappeableBitmapContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
MappeableContainer	iandNot(MappeableContainer x) Computes the in-place bitwise ANDNOT of this container with another (difference).
abstract MappeableContainer	inot(int rangeStart, int rangeEnd) Computes the in-place bitwise NOT of this container (complement).
abstract MappeableContainer	ior(MappeableArrayContainer x) Computes the in-place bitwise OR of this container with another (union).
abstract MappeableContainer	ior(MappeableBitmapContainer x) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	ior(MappeableContainer x) Computes the in-place bitwise OR of this container with another (union).
abstract MappeableContainer	ixor(MappeableArrayContainer x) Computes the in-place bitwise OR of this container with another (union).
abstract MappeableContainer	ixor(MappeableBitmapContainer x) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	ixor(MappeableContainer x) Computes the in-place bitwise OR of this container with another (union).
protected MappeableContainer	lazyIOR(MappeableContainer x)
protected MappeableContainer	lazyOR(MappeableContainer x)
abstract MappeableContainer	limit(int maxcardinality) Create a new MappeableContainer containing at most maxcardinality integers.
abstract MappeableContainer	not(int rangeStart, int rangeEnd) Computes the bitwise NOT of this container (complement).
abstract MappeableContainer	or(MappeableArrayContainer x) Computes the bitwise OR of this container with another (union).
abstract MappeableContainer	or(MappeableBitmapContainer x) Computes the bitwise OR of this container with another (union).
MappeableContainer	or(MappeableContainer x) Computes the bitwise OR of this container with another (union).
static MappeableContainer	rangeOfOnes(int start, int last) Create a container initialized with a range of consecutive values
abstract int	rank(short lowbits) Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()).
abstract MappeableContainer	remove(short x) Remove the short from this container.
abstract short	select(int j) Return the jth value
abstract void	trim() If possible, recover wasted memory.
protected abstract void	writeArray(DataOutput out) Write just the underlying array.
abstract MappeableContainer	xor(MappeableArrayContainer x) Computes the bitwise OR of this container with another (union).
abstract MappeableContainer	xor(MappeableBitmapContainer x) Computes the bitwise OR of this container with another (union).
MappeableContainer	xor(MappeableContainer x) Computes the bitwise OR of this container with another (union).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Constructor Detail

MappeableContainer

public MappeableContainer()

Method Detail

rangeOfOnes

public static MappeableContainer rangeOfOnes(int start,
                                             int last)

Create a container initialized with a range of consecutive values

Parameters:

start - first index

last - last index (range in inclusive)

Returns:

a new container initialized with the specified values

add

public abstract MappeableContainer add(short x)

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

Parameters:

x - short to be added

Returns:

the new container

and

public abstract MappeableContainer and(MappeableArrayContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

and

public abstract MappeableContainer and(MappeableBitmapContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

and

public MappeableContainer and(MappeableContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

andNot

public abstract MappeableContainer andNot(MappeableArrayContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

andNot

public abstract MappeableContainer andNot(MappeableBitmapContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

andNot

public MappeableContainer andNot(MappeableContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

clear

public abstract void clear()

Empties the container

clone

public abstract MappeableContainer clone()

Overrides:

clone in class Object

contains

public abstract boolean contains(short x)

Checks whether the contain contains the provided value

Parameters:

x - value to check

Returns:

whether the value is in the container

fillLeastSignificant16bits

public abstract 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. 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.

Parameters:

x - provided array

i - starting index

mask - indicates most significant bits

getArraySizeInBytes

protected abstract int getArraySizeInBytes()

Size of the underlying array

Returns:

size in bytes

getCardinality

public abstract int getCardinality()

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

Returns:

the cardinality

getShortIterator

public abstract ShortIterator getShortIterator()

Iterator to visit the short values in the container

Returns:

iterator

getSizeInBytes

public abstract int getSizeInBytes()

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

Returns:

estimated memory usage in bytes

iand

public abstract MappeableContainer iand(MappeableArrayContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

iand

public abstract MappeableContainer iand(MappeableBitmapContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

iand

public MappeableContainer iand(MappeableContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

iandNot

public abstract MappeableContainer iandNot(MappeableArrayContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

iandNot

public abstract MappeableContainer iandNot(MappeableBitmapContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

iandNot

public MappeableContainer iandNot(MappeableContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

inot

public abstract MappeableContainer inot(int rangeStart,
                                        int rangeEnd)

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.

Parameters:

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

rangeEnd - ending of range (exclusive)

Returns:

(partially) completmented container

ior

public abstract MappeableContainer ior(MappeableArrayContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

ior

public abstract MappeableContainer ior(MappeableBitmapContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

ior

public MappeableContainer ior(MappeableContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

ixor

public abstract MappeableContainer ixor(MappeableArrayContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

ixor

public abstract MappeableContainer ixor(MappeableBitmapContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

ixor

public MappeableContainer ixor(MappeableContainer x)

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.

Parameters:

x - other container

Returns:

aggregated container

lazyOR

protected MappeableContainer lazyOR(MappeableContainer x)

lazyIOR

protected MappeableContainer lazyIOR(MappeableContainer x)

not

public abstract MappeableContainer not(int rangeStart,
                                       int rangeEnd)

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

Parameters:

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

rangeEnd - ending of range (exclusive)

Returns:

(partially) completmented container

or

public abstract MappeableContainer or(MappeableArrayContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

or

public abstract MappeableContainer or(MappeableBitmapContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

or

public MappeableContainer or(MappeableContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

remove

public abstract MappeableContainer remove(short x)

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

Parameters:

x - to be removed

Returns:

New container

trim

public abstract void trim()

If possible, recover wasted memory.

writeArray

protected abstract void writeArray(DataOutput out)
                            throws IOException

Write just the underlying array.

Parameters:

out - output stream

Throws:

IOException - in case of failure

xor

public abstract MappeableContainer xor(MappeableArrayContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

xor

public abstract MappeableContainer xor(MappeableBitmapContainer x)

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

Parameters:

x - other container

Returns:

aggregated container

xor

public MappeableContainer xor(MappeableContainer x)

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

Parameters:

x - other parameter

Returns:

aggregated container

rank

public abstract int rank(short lowbits)

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

Parameters:

lowbits - upper limit

Returns:

the rank

select

public abstract short select(int j)

Return the jth value

Parameters:

j - index of the value

Returns:

the value

limit

public abstract MappeableContainer limit(int maxcardinality)

Create a new MappeableContainer containing at most maxcardinality integers.

Parameters:

maxcardinality - maximal cardinality

Returns:

a new bitmap with cardinality no more than maxcardinality