Container (RoaringBitmap 0.4.5 API)

java.lang.Object
- org.roaringbitmap.Container

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>

Direct Known Subclasses:

ArrayContainer, BitmapContainer
```
public abstract class Container
extends Object
implements Iterable<Short>, Cloneable, Externalizable
```
Base container class.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Container()

Constructors
Constructor and Description
`Container()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Container`	`add(short x)` Add a short to the container.
`abstract Container`	`and(ArrayContainer x)` Computes the bitwise AND of this container with another (intersection).
`abstract Container`	`and(BitmapContainer x)` Computes the bitwise AND of this container with another (intersection).
`Container`	`and(Container x)` Computes the bitwise AND of this container with another (intersection).
`abstract Container`	`andNot(ArrayContainer x)` Computes the bitwise ANDNOT of this container with another (difference).
`abstract Container`	`andNot(BitmapContainer x)` Computes the bitwise ANDNOT of this container with another (difference).
`Container`	`andNot(Container x)` Computes the bitwise ANDNOT of this container with another (difference).
`abstract void`	`clear()` Empties the container
`abstract Container`	`clone()`
`abstract boolean`	`contains(short x)` Checks whether the contain contains the provided value
`abstract void`	`deserialize(DataInput in)` Deserialize (recover) the container.
`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 Container`	`iand(ArrayContainer x)` Computes the in-place bitwise AND of this container with another (intersection).
`abstract Container`	`iand(BitmapContainer x)` Computes the in-place bitwise AND of this container with another (intersection).
`Container`	`iand(Container x)` Computes the in-place bitwise AND of this container with another (intersection).
`abstract Container`	`iandNot(ArrayContainer x)` Computes the in-place bitwise ANDNOT of this container with another (difference).
`abstract Container`	`iandNot(BitmapContainer x)` Computes the in-place bitwise ANDNOT of this container with another (difference).
`Container`	`iandNot(Container x)` Computes the in-place bitwise ANDNOT of this container with another (difference).
`abstract Container`	`inot(int rangeStart, int rangeEnd)` Computes the in-place bitwise NOT of this container (complement).
`abstract Container`	`ior(ArrayContainer x)` Computes the in-place bitwise OR of this container with another (union).
`abstract Container`	`ior(BitmapContainer x)` Computes the in-place bitwise OR of this container with another (union).
`Container`	`ior(Container x)` Computes the in-place bitwise OR of this container with another (union).
`abstract Container`	`ixor(ArrayContainer x)` Computes the in-place bitwise OR of this container with another (union).
`abstract Container`	`ixor(BitmapContainer x)` Computes the in-place bitwise OR of this container with another (union).
`Container`	`ixor(Container x)` Computes the in-place bitwise OR of this container with another (union).
`protected Container`	`lazyIOR(Container x)`
`protected Container`	`lazyOR(Container x)`
`abstract Container`	`limit(int maxcardinality)` Create a new Container containing at most maxcardinality integers.
`abstract Container`	`not(int rangeStart, int rangeEnd)` Computes the bitwise NOT of this container (complement).
`abstract Container`	`or(ArrayContainer x)` Computes the bitwise OR of this container with another (union).
`abstract Container`	`or(BitmapContainer x)` Computes the bitwise OR of this container with another (union).
`Container`	`or(Container x)` Computes the bitwise OR of this container with another (union).
`static Container`	`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 Container`	`remove(short x)` Remove the short from this container.
`abstract short`	`select(int j)` Return the jth value
`abstract void`	`serialize(DataOutput out)` Serialize the container.
`abstract int`	`serializedSizeInBytes()` Report the number of bytes required to serialize this container.
`abstract void`	`trim()` If possible, recover wasted memory.
`protected abstract void`	`writeArray(DataOutput out)` Write just the underlying array.
`abstract Container`	`xor(ArrayContainer x)` Computes the bitwise OR of this container with another (union).
`abstract Container`	`xor(BitmapContainer x)` Computes the bitwise OR of this container with another (union).
`Container`	`xor(Container 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
  - Container
```
public Container()
```
- Method Detail
  - rangeOfOnes
```
public static Container 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 Container 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 Container and(ArrayContainer 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 Container and(BitmapContainer 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 Container and(Container 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 Container andNot(ArrayContainer 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 Container andNot(BitmapContainer 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 Container andNot(Container 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 Container 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
  - deserialize
```
public abstract void deserialize(DataInput in)
                          throws IOException
```
    Deserialize (recover) the container.
    
    Parameters:
    
    in - the DataInput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - 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 Container iand(ArrayContainer 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 Container iand(BitmapContainer 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 Container iand(Container 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 Container iandNot(ArrayContainer 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 Container iandNot(BitmapContainer 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 Container iandNot(Container 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 Container 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 Container ior(ArrayContainer 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 Container ior(BitmapContainer 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 Container ior(Container 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 Container ixor(ArrayContainer 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 Container ixor(BitmapContainer 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 Container ixor(Container 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 Container lazyOR(Container x)
```
  - lazyIOR
```
protected Container lazyIOR(Container x)
```
  - not
```
public abstract Container 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 Container or(ArrayContainer 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 Container or(BitmapContainer 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 Container or(Container 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 Container remove(short x)
```
    Remove the short from this container. May create a new container.
    
    Parameters:
    
    x - to be removed
    
    Returns:
    
    New container
  - serialize
```
public abstract void serialize(DataOutput out)
                        throws IOException
```
    Serialize the container.
    
    Parameters:
    
    out - the DataOutput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - serializedSizeInBytes
```
public abstract int serializedSizeInBytes()
```
    Report the number of bytes required to serialize this container.
    
    Returns:
    
    the size in bytes
  - 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 Container xor(ArrayContainer 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 Container xor(BitmapContainer 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 Container xor(Container 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 Container limit(int maxcardinality)
```
    Create a new Container containing at most maxcardinality integers.
    
    Parameters:
    
    maxcardinality - maximal cardinality
    
    Returns:
    
    a new bitmap with cardinality no more than maxcardinality

Class Container

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.io.Externalizable

Constructor Detail

Container

Method Detail

rangeOfOnes

add

and

and

and

andNot

andNot

andNot

clear

clone

contains

deserialize

fillLeastSignificant16bits

getArraySizeInBytes

getCardinality

getShortIterator

getSizeInBytes

iand

iand

iand

iandNot

iandNot

iandNot

inot

ior

ior

ior

ixor

ixor

ixor

lazyOR

lazyIOR

not

or

or

or

remove

serialize

serializedSizeInBytes

trim

writeArray

xor

xor

xor

rank

select

limit