MutableRoaringArray (RoaringBitmap 0.5.11 API)

java.lang.Object
- org.roaringbitmap.buffer.MutableRoaringArray

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, PointableRoaringArray
```
public final class MutableRoaringArray
extends Object
implements Cloneable, Externalizable, PointableRoaringArray
```
Specialized array to store the containers used by a RoaringBitmap. This class is similar to org.roaringbitmap.RoaringArray but meant to be used with memory mapping. This is not meant to be used by end users. Objects of this class reside in RAM.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`INITIAL_CAPACITY`
`protected boolean`	`mayHaveRunContainers`
`protected static int`	`NO_OFFSET_THRESHOLD`
`protected static short`	`SERIAL_COOKIE`
`protected static short`	`SERIAL_COOKIE_NO_RUNCONTAINER`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MutableRoaringArray()

Constructors
Modifier	Constructor and Description
`protected`	`MutableRoaringArray()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`advanceUntil(short x, int pos)` Find the smallest integer index larger than pos such that getKeyAtIndex(index)>=x.
`protected void`	`append(short key, MappeableContainer value)`
`protected void`	`appendCopiesAfter(PointableRoaringArray highLowContainer, short beforeStart)` Append copies of the values AFTER a specified key (may or may not be present) to end.
`protected void`	`appendCopiesUntil(PointableRoaringArray highLowContainer, short stoppingKey)` Append copies of the values from another array, from the start
`protected void`	`appendCopy(PointableRoaringArray highLowContainer, int startingIndex, int end)` Append copies of the values from another array
`protected void`	`appendCopy(short key, MappeableContainer value)`
`protected void`	`clear()`
`MutableRoaringArray`	`clone()` Create an independent copy of the underlying array
`protected void`	`copyRange(int begin, int end, int newBegin)`
`void`	`deserialize(DataInput in)` Deserialize.
`protected void`	`extendArray(int k)`
`int`	`getCardinality(int i)` Returns the cardinality of the container at the given index.
`MappeableContainer`	`getContainer(short x)`
`MappeableContainer`	`getContainerAtIndex(int i)`
`org.roaringbitmap.buffer.MappeableContainerPointer`	`getContainerPointer()`
`org.roaringbitmap.buffer.MappeableContainerPointer`	`getContainerPointer(int startIndex)`
`int`	`getIndex(short x)`
`short`	`getKeyAtIndex(int i)`
`int`	`hashCode()`
`boolean`	`hasRunCompression()` Check whether this bitmap has had its runs compressed.
`protected int`	`headerSize()`
`protected void`	`insertNewKeyValueAt(int i, short key, MappeableContainer value)`
`void`	`readExternal(ObjectInput in)`
`protected void`	`removeAtIndex(int i)`
`protected void`	`removeIndexRange(int begin, int end)`
`protected void`	`replaceKeyAndContainerAtIndex(int i, short key, MappeableContainer c)`
`protected void`	`resize(int newLength)`
`void`	`serialize(DataOutput out)` Serialize.
`int`	`serializedSizeInBytes()` Report the number of bytes required for serialization.
`protected void`	`setContainerAtIndex(int i, MappeableContainer c)`
`int`	`size()`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INITIAL_CAPACITY
```
protected static final int INITIAL_CAPACITY
```
    See Also:
    
    Constant Field Values
  - SERIAL_COOKIE_NO_RUNCONTAINER
```
protected static final short SERIAL_COOKIE_NO_RUNCONTAINER
```
    See Also:
    
    Constant Field Values
  - SERIAL_COOKIE
```
protected static final short SERIAL_COOKIE
```
    See Also:
    
    Constant Field Values
  - NO_OFFSET_THRESHOLD
```
protected static final int NO_OFFSET_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - mayHaveRunContainers
```
protected boolean mayHaveRunContainers
```
- Constructor Detail
  - MutableRoaringArray
```
protected MutableRoaringArray()
```
- Method Detail
  - append
```
protected void append(short key,
                      MappeableContainer value)
```
  - appendCopiesAfter
```
protected void appendCopiesAfter(PointableRoaringArray highLowContainer,
                                 short beforeStart)
```
    Append copies of the values AFTER a specified key (may or may not be present) to end.
    
    Parameters:
    
    highLowContainer - the other array
    
    beforeStart - given key is the largest key that we won't copy
  - appendCopiesUntil
```
protected void appendCopiesUntil(PointableRoaringArray highLowContainer,
                                 short stoppingKey)
```
    Append copies of the values from another array, from the start
    
    Parameters:
    
    highLowContainer - the other array
    
    stoppingKey - any equal or larger key in other array will terminate copying
  - appendCopy
```
protected void appendCopy(PointableRoaringArray highLowContainer,
                          int startingIndex,
                          int end)
```
    Append copies of the values from another array
    
    Parameters:
    
    highLowContainer - other array
    
    startingIndex - starting index in the other array
    
    end - last index array in the other array
  - appendCopy
```
protected void appendCopy(short key,
                          MappeableContainer value)
```
  - clear
```
protected void clear()
```
  - clone
```
public MutableRoaringArray clone()
```
    Description copied from interface: PointableRoaringArray
    
    Create an independent copy of the underlying array
    
    Specified by:
    
    clone in interface PointableRoaringArray
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a copy
  - deserialize
```
public void deserialize(DataInput in)
                 throws IOException
```
    Deserialize.
    
    Parameters:
    
    in - the DataInput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - extendArray
```
protected void extendArray(int k)
```
  - getContainer
```
public MappeableContainer getContainer(short x)
```
    Specified by:
    
    getContainer in interface PointableRoaringArray
    
    Parameters:
    
    x - 16-bit key
    
    Returns:
    
    matching container
  - getContainerAtIndex
```
public MappeableContainer getContainerAtIndex(int i)
```
    Specified by:
    
    getContainerAtIndex in interface PointableRoaringArray
    
    Parameters:
    
    i - index
    
    Returns:
    
    matching container
  - getContainerPointer
```
public org.roaringbitmap.buffer.MappeableContainerPointer getContainerPointer()
```
    Specified by:
    
    getContainerPointer in interface PointableRoaringArray
    
    Returns:
    
    a ContainerPointer to iterator over the array
  - getContainerPointer
```
public org.roaringbitmap.buffer.MappeableContainerPointer getContainerPointer(int startIndex)
```
    Specified by:
    
    getContainerPointer in interface PointableRoaringArray
    
    Parameters:
    
    startIndex - starting index
    
    Returns:
    
    a ContainerPointer to iterator over the array initially positioned at startIndex
  - getIndex
```
public int getIndex(short x)
```
    Specified by:
    
    getIndex in interface PointableRoaringArray
    
    Parameters:
    
    x - 16-bit key
    
    Returns:
    
    corresponding index
  - getKeyAtIndex
```
public short getKeyAtIndex(int i)
```
    Specified by:
    
    getKeyAtIndex in interface PointableRoaringArray
    
    Parameters:
    
    i - the index
    
    Returns:
    
    16-bit key at the index
  - advanceUntil
```
public int advanceUntil(short x,
                        int pos)
```
    Description copied from interface: PointableRoaringArray
    
    Find the smallest integer index larger than pos such that getKeyAtIndex(index)>=x. If none can be found, return size.
    
    Specified by:
    
    advanceUntil in interface PointableRoaringArray
    
    Parameters:
    
    x - minimal value
    
    pos - index to exceed
    
    Returns:
    
    the smallest index greater than pos such that getKeyAtIndex(index) is at least as large as min, or size if it is not possible.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - insertNewKeyValueAt
```
protected void insertNewKeyValueAt(int i,
                                   short key,
                                   MappeableContainer value)
```
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - removeAtIndex
```
protected void removeAtIndex(int i)
```
  - removeIndexRange
```
protected void removeIndexRange(int begin,
                                int end)
```
  - resize
```
protected void resize(int newLength)
```
  - copyRange
```
protected void copyRange(int begin,
                         int end,
                         int newBegin)
```
  - hasRunCompression
```
public boolean hasRunCompression()
```
    Description copied from interface: PointableRoaringArray
    
    Check whether this bitmap has had its runs compressed.
    
    Specified by:
    
    hasRunCompression in interface PointableRoaringArray
    
    Returns:
    
    whether this bitmap has run compression
  - serialize
```
public void serialize(DataOutput out)
               throws IOException
```
    Serialize. The current bitmap is not modified.
    
    Specified by:
    
    serialize in interface PointableRoaringArray
    
    Parameters:
    
    out - the DataOutput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - serializedSizeInBytes
```
public int serializedSizeInBytes()
```
    Report the number of bytes required for serialization.
    
    Specified by:
    
    serializedSizeInBytes in interface PointableRoaringArray
    
    Returns:
    
    the size in bytes
  - headerSize
```
protected int headerSize()
```
  - setContainerAtIndex
```
protected void setContainerAtIndex(int i,
                                   MappeableContainer c)
```
  - replaceKeyAndContainerAtIndex
```
protected void replaceKeyAndContainerAtIndex(int i,
                                             short key,
                                             MappeableContainer c)
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface PointableRoaringArray
    
    Returns:
    
    number of keys
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - getCardinality
```
public int getCardinality(int i)
```
    Description copied from interface: PointableRoaringArray
    
    Returns the cardinality of the container at the given index. This method is expected to be fast.
    
    Specified by:
    
    getCardinality in interface PointableRoaringArray
    
    Parameters:
    
    i - index
    
    Returns:
    
    the cardinality

Class MutableRoaringArray

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INITIAL_CAPACITY

SERIAL_COOKIE_NO_RUNCONTAINER

SERIAL_COOKIE

NO_OFFSET_THRESHOLD

mayHaveRunContainers

Constructor Detail

MutableRoaringArray

Method Detail

append

appendCopiesAfter

appendCopiesUntil

appendCopy

appendCopy

clear

clone

deserialize

extendArray

getContainer

getContainerAtIndex

getContainerPointer

getContainerPointer

getIndex

getKeyAtIndex

advanceUntil

hashCode

insertNewKeyValueAt

readExternal

removeAtIndex

removeIndexRange

resize

copyRange

hasRunCompression

serialize

serializedSizeInBytes

headerSize

setContainerAtIndex

replaceKeyAndContainerAtIndex

size

writeExternal

getCardinality