org.roaringbitmap.buffer

Class MappeableArrayContainer

java.lang.Object

org.roaringbitmap.buffer.MappeableContainer

org.roaringbitmap.buffer.MappeableArrayContainer

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>

public final class MappeableArrayContainer
extends MappeableContainer
implements Cloneable, Serializable

Simple container made of an array of 16-bit integers. Unlike org.roaringbitmap.ArrayContainer, this class uses a ShortBuffer to store data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cardinality
protected ShortBuffer	content
protected static int	DEFAULT_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
MappeableArrayContainer() Create an array container with default capacity
MappeableArrayContainer(int capacity) Create an array container with specified capacity
MappeableArrayContainer(int firstOfRun, int lastOfRun) Create an array container with a run of ones from firstOfRun to lastOfRun, inclusive.
MappeableArrayContainer(ShortBuffer array, int cardinality) Construct a new ArrayContainer backed by the provided ShortBuffer.

Method Summary

Modifier and Type	Method and Description
MappeableContainer	add(short x) running time is in O(n) time if insert is not in order.
MappeableArrayContainer	and(MappeableArrayContainer value2) Computes the bitwise AND of this container with another (intersection).
MappeableContainer	and(MappeableBitmapContainer x) Computes the bitwise AND of this container with another (intersection).
MappeableArrayContainer	andNot(MappeableArrayContainer value2) Computes the bitwise ANDNOT of this container with another (difference).
MappeableArrayContainer	andNot(MappeableBitmapContainer value2) Computes the bitwise ANDNOT of this container with another (difference).
void	clear() Empties the container
MappeableArrayContainer	clone()
boolean	contains(short x) Checks whether the contain contains the provided value
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.
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()
MappeableArrayContainer	iand(MappeableArrayContainer value2) Computes the in-place bitwise AND of this container with another (intersection).
MappeableContainer	iand(MappeableBitmapContainer value2) Computes the in-place bitwise AND of this container with another (intersection).
MappeableArrayContainer	iandNot(MappeableArrayContainer value2) Computes the in-place bitwise ANDNOT of this container with another (difference).
MappeableArrayContainer	iandNot(MappeableBitmapContainer value2) Computes the in-place bitwise ANDNOT of this container with another (difference).
MappeableContainer	inot(int firstOfRange, int lastOfRange) Computes the in-place bitwise NOT of this container (complement).
MappeableContainer	ior(MappeableArrayContainer value2) 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).
Iterator<Short>	iterator()
MappeableContainer	ixor(MappeableArrayContainer value2) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	ixor(MappeableBitmapContainer x) Computes the in-place bitwise OR of this container with another (union).
MappeableContainer	limit(int maxcardinality) Create a new MappeableContainer containing at most maxcardinality integers.
protected void	loadData(MappeableBitmapContainer bitmapContainer)
MappeableContainer	not(int firstOfRange, int lastOfRange) Computes the bitwise NOT of this container (complement).
MappeableContainer	or(MappeableArrayContainer value2) Computes the bitwise OR of this container with another (union).
MappeableContainer	or(MappeableBitmapContainer 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(short x) Remove the short from this container.
short	select(int j) Return the jth value
MappeableBitmapContainer	toBitmapContainer() Copies the data in a bitmap 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 x) 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

DEFAULT_MAX_SIZE

protected static final int DEFAULT_MAX_SIZE

See Also:

Constant Field Values

cardinality

protected int cardinality

content

protected ShortBuffer content

Constructor Detail

MappeableArrayContainer

public MappeableArrayContainer()

Create an array container with default capacity

MappeableArrayContainer

public MappeableArrayContainer(int capacity)

Create an array container with specified capacity

Parameters:

capacity - The capacity of the container

MappeableArrayContainer

public MappeableArrayContainer(int firstOfRun,
                               int lastOfRun)

Create an array container with a run of ones from firstOfRun to lastOfRun, inclusive. Caller is responsible for making sure the range is small enough that ArrayContainer is appropriate.

Parameters:

firstOfRun - first index

lastOfRun - last index (range is inclusive)

MappeableArrayContainer

public MappeableArrayContainer(ShortBuffer array,
                               int cardinality)

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

Parameters:

array - ShortBuffer where the data is stored

cardinality - cardinality (number of values stored)

Method Detail

add

public MappeableContainer add(short x)

running time is in O(n) time if insert is not in order.

Specified by:

add in class MappeableContainer

Parameters:

x - 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 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 MappeableArrayContainer 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 MappeableArrayContainer 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 MappeableArrayContainer 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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

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 MappeableArrayContainer iand(MappeableArrayContainer value2)

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:

value2 - other container

Returns:

aggregated container

iand

public MappeableContainer iand(MappeableBitmapContainer value2)

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:

value2 - other container

Returns:

aggregated container

iandNot

public MappeableArrayContainer iandNot(MappeableArrayContainer value2)

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:

value2 - other container

Returns:

aggregated container

iandNot

public MappeableArrayContainer iandNot(MappeableBitmapContainer value2)

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:

value2 - 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 MappeableContainer 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 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

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 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:

ixor in class MappeableContainer

Parameters:

x - other container

Returns:

aggregated container

loadData

protected void loadData(MappeableBitmapContainer bitmapContainer)

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 MappeableContainer 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 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

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

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

toBitmapContainer

public MappeableBitmapContainer toBitmapContainer()

Copies the data in a bitmap container.

Returns:

the bitmap 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 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:

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