ArrayContainer (RoaringBitmap 0.1.3 API)

java.lang.Object
- org.roaringbitmap.buffer.Container
- - org.roaringbitmap.buffer.ArrayContainer

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Short>
```
public final class ArrayContainer
extends Container
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 DEFAULTMAXSIZE

Fields
Modifier and Type	Field and Description
`protected int`	`cardinality`
`protected ShortBuffer`	`content`
`protected static int`	`DEFAULTMAXSIZE`

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Container`	`add(short x)` running time is in O(n) time if insert is not in order.
`ArrayContainer`	`and(ArrayContainer value2)` Computes the bitwise AND of this container with another (intersection).
`Container`	`and(BitmapContainer x)` Computes the bitwise AND of this container with another (intersection).
`ArrayContainer`	`andNot(ArrayContainer value2)` Computes the bitwise ANDNOT of this container with another (difference).
`ArrayContainer`	`andNot(BitmapContainer value2)` Computes the bitwise ANDNOT of this container with another (difference).
`void`	`clear()` Empties the container
`ArrayContainer`	`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()`
`ArrayContainer`	`iand(ArrayContainer value2)` Computes the in-place bitwise AND of this container with another (intersection).
`Container`	`iand(BitmapContainer value2)` Computes the in-place bitwise AND of this container with another (intersection).
`ArrayContainer`	`iandNot(ArrayContainer value2)` Computes the in-place bitwise ANDNOT of this container with another (difference).
`ArrayContainer`	`iandNot(BitmapContainer value2)` Computes the in-place bitwise ANDNOT of this container with another (difference).
`Container`	`inot(int firstOfRange, int lastOfRange)` Computes the in-place bitwise NOT of this container (complement).
`Container`	`ior(ArrayContainer value2)` Computes the in-place bitwise OR of this container with another (union).
`Container`	`ior(BitmapContainer x)` Computes the in-place bitwise OR of this container with another (union).
`Iterator<Short>`	`iterator()`
`Container`	`ixor(ArrayContainer value2)` Computes the in-place bitwise OR of this container with another (union).
`Container`	`ixor(BitmapContainer x)` Computes the in-place bitwise OR of this container with another (union).
`protected void`	`loadData(BitmapContainer bitmapContainer)`
`Container`	`not(int firstOfRange, int lastOfRange)` Computes the bitwise NOT of this container (complement).
`Container`	`or(ArrayContainer value2)` Computes the bitwise OR of this container with another (union).
`Container`	`or(BitmapContainer x)` Computes the bitwise OR of this container with another (union).
`void`	`readExternal(ObjectInput in)`
`Container`	`remove(short x)` Remove the short from this container.
`BitmapContainer`	`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)`
`Container`	`xor(ArrayContainer value2)` Computes the bitwise OR of this container with another (union).
`Container`	`xor(BitmapContainer x)` Computes the bitwise OR of this container with another (union).

Methods inherited from class org.roaringbitmap.buffer.Container
and, andNot, iand, iandNot, ior, ixor, 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
  - DEFAULTMAXSIZE
```
protected static final int DEFAULTMAXSIZE
```
    See Also:
    
    Constant Field Values
  - cardinality
```
protected int cardinality
```
  - content
```
protected ShortBuffer content
```
- Constructor Detail
  - ArrayContainer
```
public ArrayContainer()
```
    Create an array container with default capacity
  - ArrayContainer
```
public ArrayContainer(int capacity)
```
    Create an array container with specified capacity
    
    Parameters:
    
    capacity -
  - ArrayContainer
```
public ArrayContainer(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)
  - ArrayContainer
```
public ArrayContainer(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 Container add(short x)
```
    running time is in O(n) time if insert is not in order.
    
    Specified by:
    
    add in class Container
    
    Parameters:
    
    x - 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 x)
```
    Description copied from class: Container
    
    Computes the bitwise AND of this container with another (intersection). This container as well as the provided container are left unaffected.
    
    Specified by:
    
    and in class Container
    
    Parameters:
    
    x - other container
    
    Returns:
    
    aggregated container
  - andNot
```
public ArrayContainer 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 ArrayContainer 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
  - clear
```
public void clear()
```
    Description copied from class: Container
    
    Empties the container
    
    Specified by:
    
    clear in class Container
  - clone
```
public ArrayContainer clone()
```
    Specified by:
    
    clone in class Container
  - contains
```
public boolean contains(short x)
```
    Description copied from class: Container
    
    Checks whether the contain contains the provided value
    
    Specified by:
    
    contains in class Container
    
    Parameters:
    
    x - value to check
    
    Returns:
    
    whether the value is in the container
  - 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: Container
    
    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 Container
    
    Parameters:
    
    x - provided array
    
    i - starting index
    
    mask - indicates most significant bits
  - getArraySizeInBytes
```
protected int getArraySizeInBytes()
```
    Description copied from class: Container
    
    Size of the underlying array
    
    Specified by:
    
    getArraySizeInBytes in class Container
    
    Returns:
    
    size in bytes
  - getCardinality
```
public int getCardinality()
```
    Description copied from class: Container
    
    Computes the distinct number of short values in the container. Can be expected to run in constant time.
    
    Specified by:
    
    getCardinality in class Container
    
    Returns:
    
    the cardinality
  - getShortIterator
```
public ShortIterator getShortIterator()
```
    Description copied from class: Container
    
    Iterator to visit the short values in the container
    
    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
  - iand
```
public ArrayContainer iand(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - iand
```
public Container iand(BitmapContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - iandNot
```
public ArrayContainer iandNot(ArrayContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - iandNot
```
public ArrayContainer iandNot(BitmapContainer value2)
```
    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:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - 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) completmented container
  - ior
```
public Container 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 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
  - 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 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 Container
    
    Parameters:
    
    value2 - other container
    
    Returns:
    
    aggregated container
  - ixor
```
public Container ixor(BitmapContainer x)
```
    Description copied from class: Container
    
    Computes the in-place bitwise OR of this container with another (union). The current container is generally modified, whereas the provided container (x) is unaffected. May generate a new container.
    
    Specified by:
    
    ixor in class Container
    
    Parameters:
    
    x - other container
    
    Returns:
    
    aggregated container
  - loadData
```
protected void loadData(BitmapContainer bitmapContainer)
```
  - 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) completmented container
  - 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
  - or
```
public Container or(BitmapContainer x)
```
    Description copied from class: Container
    
    Computes the bitwise OR of this container with another (union). This container as well as the provided container are left unaffected.
    
    Specified by:
    
    or in class Container
    
    Parameters:
    
    x - other container
    
    Returns:
    
    aggregated container
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - remove
```
public Container remove(short x)
```
    Description copied from class: Container
    
    Remove the short from this container. May create a new container.
    
    Specified by:
    
    remove in class Container
    
    Parameters:
    
    x - to be removed
    
    Returns:
    
    New container
  - toBitmapContainer
```
public BitmapContainer 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: 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
  - 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 OR of this container with another (union). 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 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:
    
    xor in class Container
    
    Parameters:
    
    x - other container
    
    Returns:
    
    aggregated container

Class ArrayContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.roaringbitmap.buffer.Container

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULTMAXSIZE

cardinality

content

Constructor Detail

ArrayContainer

ArrayContainer

ArrayContainer

ArrayContainer

Method Detail

add

and

and

andNot

andNot

clear

clone

contains

equals

fillLeastSignificant16bits

getArraySizeInBytes

getCardinality

getShortIterator

getSizeInBytes

hashCode

iand

iand

iandNot

iandNot

inot

ior

ior

iterator

ixor

ixor

loadData

not

or

or

readExternal

remove

toBitmapContainer

toString

trim

writeArray

writeExternal

xor

xor