BitmapContainer (RoaringBitmap 0.7.0 API)

java.lang.Object
- org.roaringbitmap.Container
- - org.roaringbitmap.BitmapContainer

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>
```
public final class BitmapContainer
extends Container
implements Cloneable
```
Simple bitset-like container.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`MAX_CAPACITY`
`static boolean`	`USE_BRANCHLESS` optimization flag: whether the cardinality of the bitmaps is maintained through branchless operations

Fields inherited from class org.roaringbitmap.Container
ContainerNames

Constructor Summary

Constructors
Constructor and Description
`BitmapContainer()` Create a bitmap container with all bits set to false
`BitmapContainer(int firstOfRun, int lastOfRun)` Create a bitmap container with a run of ones from firstOfRun to lastOfRun.
`BitmapContainer(long[] newBitmap, int newCardinality)` Create a new container, no copy is made.
`BitmapContainer(MappeableBitmapContainer bc)` Creates a new non-mappeable container from a mappeable one.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 i)` Add a short to the container.
`ArrayContainer`	`and(ArrayContainer value2)` Computes the bitwise AND of this container with another (intersection).
`Container`	`and(BitmapContainer value2)` Computes the bitwise AND of this container with another (intersection).
`Container`	`and(RunContainer x)` Computes the bitwise AND of this container with another (intersection).
`int`	`andCardinality(ArrayContainer value2)`
`int`	`andCardinality(BitmapContainer value2)`
`int`	`andCardinality(RunContainer x)`
`Container`	`andNot(ArrayContainer value2)` Computes the bitwise ANDNOT of this container with another (difference).
`Container`	`andNot(BitmapContainer value2)` Computes the bitwise ANDNOT of this container with another (difference).
`Container`	`andNot(RunContainer x)` Computes the bitwise ANDNOT of this container with another (difference).
`protected long`	`bitValue(short i)`
`protected int`	`cardinalityInRange(int start, int end)`
`void`	`clear()` Empties the container
`BitmapContainer`	`clone()`
`protected void`	`computeCardinality()` Recomputes the cardinality of the bitmap.
`protected boolean`	`contains(ArrayContainer arrayContainer)`
`protected boolean`	`contains(BitmapContainer bitmapContainer)`
`protected boolean`	`contains(RunContainer runContainer)`
`boolean`	`contains(short i)` Checks whether the contain contains the provided value
`void`	`deserialize(DataInput in)` Deserialize (recover) the container.
`boolean`	`equals(Object o)`
`protected void`	`fillArray(short[] array)` Fill the array with set bits
`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.
`int`	`first()` Get the first integer held in the container
`Container`	`flip(short i)` Add a short to the container if it is not present, otherwise remove it.
`void`	`forEach(short msb, IntConsumer ic)` Iterate through the values of this container and pass them along to the IntConsumer, using msb as the 16 most significant bits.
`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.
`static ShortIterator`	`getReverseShortIterator(long[] bitmap)` Return a bitmap iterator over this array
`PeekableShortIterator`	`getShortIterator()` Iterator to visit the short values in the container in ascending order.
`static PeekableShortIterator`	`getShortIterator(long[] bitmap)` Return a bitmap iterator over this array
`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 b2)` Computes the in-place bitwise AND of this container with another (intersection).
`Container`	`iand(BitmapContainer b2)` 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 b2)` Computes the in-place bitwise ANDNOT of this container with another (difference).
`Container`	`iandNot(BitmapContainer b2)` 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 value2)`
`protected Container`	`ilazyor(BitmapContainer x)`
`protected Container`	`ilazyor(RunContainer x)`
`Container`	`inot(int firstOfRange, int lastOfRange)` Computes the in-place bitwise NOT of this container (complement).
`boolean`	`intersects(ArrayContainer value2)` Returns true if the current container intersects the other container.
`boolean`	`intersects(BitmapContainer value2)` Returns true if the current container intersects the other container.
`boolean`	`intersects(RunContainer x)` Returns true if the current container intersects the other container.
`BitmapContainer`	`ior(ArrayContainer value2)` Computes the in-place bitwise OR of this container with another (union).
`Container`	`ior(BitmapContainer b2)` 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 value2)` Computes the in-place bitwise XOR of this container with another (symmetric difference).
`Container`	`ixor(BitmapContainer b2)` 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).
`int`	`last()` Get the last integer held in the container
`protected Container`	`lazyor(ArrayContainer value2)`
`protected Container`	`lazyor(BitmapContainer x)`
`protected Container`	`lazyor(RunContainer x)`
`Container`	`limit(int maxcardinality)` Create a new Container containing at most maxcardinality integers.
`protected void`	`loadData(ArrayContainer arrayContainer)`
`int`	`nextSetBit(int i)` Find the index of the next set bit greater or equal to i, returns -1 if none found.
`short`	`nextUnsetBit(int i)` Find the index of the next unset bit greater or equal to i, returns -1 if none found.
`Container`	`not(int firstOfRange, int lastOfRange)` Computes the bitwise NOT of this container (complement).
`int`	`numberOfRunsAdjustment()` Computes the number of runs
`int`	`numberOfRunsLowerBound(int mustNotExceed)` Counts how many runs there is in the bitmap, up to a maximum
`Container`	`or(ArrayContainer value2)` Computes the bitwise OR of this container with another (union).
`Container`	`or(BitmapContainer value2)` 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`	`prevSetBit(int i)` Find the index of the previous set bit less than or equal to i, returns -1 if none found.
`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 i)` 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 RunContainers, when the result is smaller.
`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 unusedCardinality)`
`ArrayContainer`	`toArrayContainer()` Copies the data to an array container
`BitmapContainer`	`toBitmapContainer()` Convert the current container to a BitmapContainer, if a conversion is needed.
`LongBuffer`	`toLongBuffer()` Return the content of this container as a LongBuffer.
`MappeableContainer`	`toMappeableContainer()` Convert to a mappeable container.
`String`	`toString()`
`void`	`trim()` If possible, recover wasted memory.
`protected void`	`updateCardinality(int prevOnes, int newOnes)`
`protected void`	`writeArray(DataOutput out)` Write just the underlying array.
`void`	`writeExternal(ObjectOutput out)`
`Container`	`xor(ArrayContainer value2)` Computes the bitwise XOR of this container with another (symmetric difference).
`Container`	`xor(BitmapContainer value2)` 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, andCardinality, andNot, assertNonEmpty, contains, getContainerName, iand, iandNot, intersects, ior, ixor, lazyIOR, lazyOR, or, rangeOfOnes, xor, xorCardinality

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
  - MAX_CAPACITY
```
protected static final int MAX_CAPACITY
```
    See Also:
    
    Constant Field Values
  - USE_BRANCHLESS
```
public static final boolean USE_BRANCHLESS
```
    optimization flag: whether the cardinality of the bitmaps is maintained through branchless operations
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BitmapContainer
```
public BitmapContainer()
```
    Create a bitmap container with all bits set to false
  - BitmapContainer
```
public BitmapContainer(int firstOfRun,
                       int lastOfRun)
```
    Create a bitmap container with a run of ones from firstOfRun to lastOfRun. Caller must ensure that the range isn't so small that an ArrayContainer should have been created instead
    
    Parameters:
    
    firstOfRun - first index
    
    lastOfRun - last index (range is exclusive)
  - BitmapContainer
```
public BitmapContainer(long[] newBitmap,
                       int newCardinality)
```
    Create a new container, no copy is made.
    
    Parameters:
    
    newBitmap - content
    
    newCardinality - desired cardinality.
  - BitmapContainer
```
public BitmapContainer(MappeableBitmapContainer bc)
```
    Creates a new non-mappeable container from a mappeable one. This copies the data.
    
    Parameters:
    
    bc - the original container
- Method Detail
  - getReverseShortIterator
```
public static ShortIterator getReverseShortIterator(long[] bitmap)
```
    Return a bitmap iterator over this array
    
    Parameters:
    
    bitmap - array to be iterated over
    
    Returns:
    
    an iterator
  - getShortIterator
```
public static PeekableShortIterator getShortIterator(long[] bitmap)
```
    Return a bitmap iterator over this array
    
    Parameters:
    
    bitmap - array to be iterated over
    
    Returns:
    
    an iterator
  - serializedSizeInBytes
```
protected static int serializedSizeInBytes(int unusedCardinality)
```
  - 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
  - add
```
public Container add(short i)
```
    Description copied from class: Container
    
    Add a short to the container. May generate a new container.
    
    Specified by:
    
    add in class Container
    
    Parameters:
    
    i - short to be added
    
    Returns:
    
    the new container
  - and
```
public ArrayContainer and(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - and
```
public Container and(BitmapContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - 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
  - andCardinality
```
public int andCardinality(ArrayContainer value2)
```
    Specified by:
    
    andCardinality in class Container
  - andCardinality
```
public int andCardinality(BitmapContainer value2)
```
    Specified by:
    
    andCardinality in class Container
  - andCardinality
```
public int andCardinality(RunContainer x)
```
    Specified by:
    
    andCardinality in class Container
  - andNot
```
public Container andNot(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - andNot
```
public Container andNot(BitmapContainer value2)
```
    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:
    
    value2 - 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
  - clear
```
public void clear()
```
    Description copied from class: Container
    
    Empties the container
    
    Specified by:
    
    clear in class Container
  - clone
```
public BitmapContainer clone()
```
    Specified by:
    
    clone in class Container
  - computeCardinality
```
protected void computeCardinality()
```
    Recomputes the cardinality of the bitmap.
  - cardinalityInRange
```
protected int cardinalityInRange(int start,
                                 int end)
```
  - updateCardinality
```
protected void updateCardinality(int prevOnes,
                                 int newOnes)
```
  - contains
```
public boolean contains(short i)
```
    Description copied from class: Container
    
    Checks whether the contain contains the provided value
    
    Specified by:
    
    contains in class Container
    
    Parameters:
    
    i - value to check
    
    Returns:
    
    whether the value is in the container
  - contains
```
protected boolean contains(BitmapContainer bitmapContainer)
```
    Specified by:
    
    contains in class Container
  - contains
```
protected boolean contains(RunContainer runContainer)
```
    Specified by:
    
    contains in class Container
  - contains
```
protected boolean contains(ArrayContainer arrayContainer)
```
    Specified by:
    
    contains in class Container
  - bitValue
```
protected long bitValue(short i)
```
  - 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.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - fillArray
```
protected void fillArray(short[] array)
```
    Fill the array with set bits
    
    Parameters:
    
    array - container (should be sufficiently large)
  - 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
  - flip
```
public Container flip(short i)
```
    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:
    
    i - short to be added
    
    Returns:
    
    the new container
  - 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
  - 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
  - getShortIterator
```
public PeekableShortIterator 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
  - 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
  - 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
  - iand
```
public Container iand(ArrayContainer b2)
```
    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:
    
    b2 - other container
    
    Returns:
    
    aggregated container
  - iand
```
public Container iand(BitmapContainer b2)
```
    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:
    
    b2 - 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(ArrayContainer b2)
```
    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:
    
    b2 - other container
    
    Returns:
    
    aggregated container
  - iandNot
```
public Container iandNot(BitmapContainer b2)
```
    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:
    
    b2 - 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
  - ilazyor
```
protected Container ilazyor(ArrayContainer value2)
```
  - ilazyor
```
protected Container ilazyor(BitmapContainer x)
```
  - ilazyor
```
protected Container ilazyor(RunContainer x)
```
  - inot
```
public Container inot(int firstOfRange,
                      int lastOfRange)
```
    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:
    
    firstOfRange - beginning of range (inclusive); 0 is beginning of this container.
    
    lastOfRange - ending of range (exclusive)
    
    Returns:
    
    (partially) complemented container
  - intersects
```
public boolean intersects(ArrayContainer value2)
```
    Description copied from class: Container
    
    Returns true if the current container intersects the other container.
    
    Specified by:
    
    intersects in class Container
    
    Parameters:
    
    value2 - other container
    
    Returns:
    
    whether they intersect
  - intersects
```
public boolean intersects(BitmapContainer value2)
```
    Description copied from class: Container
    
    Returns true if the current container intersects the other container.
    
    Specified by:
    
    intersects in class Container
    
    Parameters:
    
    value2 - 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
  - ior
```
public BitmapContainer ior(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - ior
```
public Container ior(BitmapContainer b2)
```
    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:
    
    b2 - 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
  - 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
  - iterator
```
public Iterator<Short> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Short>
  - ixor
```
public Container ixor(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - ixor
```
public Container ixor(BitmapContainer b2)
```
    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:
    
    b2 - 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
  - lazyor
```
protected Container lazyor(ArrayContainer value2)
```
  - lazyor
```
protected Container lazyor(BitmapContainer x)
```
  - lazyor
```
protected Container lazyor(RunContainer x)
```
  - 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
  - loadData
```
protected void loadData(ArrayContainer arrayContainer)
```
  - nextSetBit
```
public int nextSetBit(int i)
```
    Find the index of the next set bit greater or equal to i, returns -1 if none found.
    
    Parameters:
    
    i - starting index
    
    Returns:
    
    index of the next set bit
  - nextUnsetBit
```
public short nextUnsetBit(int i)
```
    Find the index of the next unset bit greater or equal to i, returns -1 if none found.
    
    Parameters:
    
    i - starting index
    
    Returns:
    
    index of the next unset bit
  - not
```
public Container not(int firstOfRange,
                     int lastOfRange)
```
    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:
    
    firstOfRange - beginning of range (inclusive); 0 is beginning of this container.
    
    lastOfRange - ending of range (exclusive)
    
    Returns:
    
    (partially) complemented container
  - numberOfRunsAdjustment
```
public int numberOfRunsAdjustment()
```
    Computes the number of runs
    
    Returns:
    
    the number of runs
  - numberOfRunsLowerBound
```
public int numberOfRunsLowerBound(int mustNotExceed)
```
    Counts how many runs there is in the bitmap, up to a maximum
    
    Parameters:
    
    mustNotExceed - maximum of runs beyond which counting is pointless
    
    Returns:
    
    estimated number of courses
  - or
```
public Container or(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - isFull
```
protected boolean isFull()
```
  - or
```
public Container or(BitmapContainer value2)
```
    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:
    
    value2 - 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
  - prevSetBit
```
public int prevSetBit(int i)
```
    Find the index of the previous set bit less than or equal to i, returns -1 if none found.
    
    Parameters:
    
    i - starting index
    
    Returns:
    
    index of the previous set bit
  - 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
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - 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
  - remove
```
public Container remove(short i)
```
    Description copied from class: Container
    
    Remove the short from this container. May create a new container.
    
    Specified by:
    
    remove in class Container
    
    Parameters:
    
    i - to be removed
    
    Returns:
    
    New 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
  - runOptimize
```
public Container runOptimize()
```
    Description copied from class: Container
    
    Convert to RunContainers, when the result is smaller. Overridden by RunContainer to possibility switch from RunContainer to a smaller alternative. Overridden by BitmapContainer with a more efficient approach.
    
    Specified by:
    
    runOptimize in class Container
    
    Returns:
    
    the new container
  - 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
  - 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
  - toArrayContainer
```
public ArrayContainer toArrayContainer()
```
    Copies the data to an array container
    
    Returns:
    
    the array container
  - toLongBuffer
```
public LongBuffer toLongBuffer()
```
    Return the content of this container as a LongBuffer. This creates a copy and might be relatively slow.
    
    Returns:
    
    the LongBuffer
  - toMappeableContainer
```
public MappeableContainer toMappeableContainer()
```
    Description copied from class: Container
    
    Convert to a mappeable container.
    
    Specified by:
    
    toMappeableContainer in class Container
    
    Returns:
    
    the mappeable container
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - xor
```
public Container xor(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - xor
```
public Container xor(BitmapContainer value2)
```
    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:
    
    value2 - 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
  - forEach
```
public void forEach(short msb,
                    IntConsumer ic)
```
    Description copied from class: Container
    
    Iterate through the values of this container and pass them along to the IntConsumer, using msb as the 16 most significant bits.
    
    Specified by:
    
    forEach in class Container
    
    Parameters:
    
    msb - 16 most significant bits
    
    ic - consumer
  - toBitmapContainer
```
public BitmapContainer toBitmapContainer()
```
    Description copied from class: Container
    
    Convert the current container to a BitmapContainer, if a conversion is needed. If the container is already a bitmap, the container is returned unchanged.
    
    Specified by:
    
    toBitmapContainer in class Container
    
    Returns:
    
    a bitmap container
  - first
```
public int first()
```
    Description copied from class: Container
    
    Get the first integer held in the container
    
    Specified by:
    
    first in class Container
    
    Returns:
    
    the first integer in the container
  - last
```
public int last()
```
    Description copied from class: Container
    
    Get the last integer held in the container
    
    Specified by:
    
    last in class Container
    
    Returns:
    
    the last integer in the container

Class BitmapContainer

Field Summary

Fields inherited from class org.roaringbitmap.Container

Constructor Summary

Method Summary

Methods inherited from class org.roaringbitmap.Container

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

MAX_CAPACITY

USE_BRANCHLESS

Constructor Detail

BitmapContainer

BitmapContainer

BitmapContainer

BitmapContainer

Method Detail

getReverseShortIterator

getShortIterator

serializedSizeInBytes

add

add

and

and

and

andCardinality

andCardinality

andCardinality

andNot

andNot

andNot

clear

clone

computeCardinality

cardinalityInRange

updateCardinality

contains

contains

contains

contains

bitValue

deserialize

equals

fillArray

fillLeastSignificant16bits

flip

getArraySizeInBytes

getCardinality

getReverseShortIterator

getShortIterator

getSizeInBytes

hashCode

iadd

iand

iand

iand

iandNot

iandNot

iandNot

ilazyor

ilazyor

ilazyor

inot

intersects

intersects

intersects

ior

ior

ior

iremove

iterator

ixor

ixor

ixor

lazyor

lazyor

lazyor

limit

loadData

nextSetBit