RoaringArray (RoaringBitmap 0.6.51 API)

java.lang.Object
- org.roaringbitmap.RoaringArray

All Implemented Interfaces:

Externalizable, Serializable, Cloneable
```
public final class RoaringArray
extends Object
implements Cloneable, Externalizable
```
Specialized array to store the containers used by a RoaringBitmap. This is not meant to be used by end users.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected static int NO_OFFSET_THRESHOLD

protected static short SERIAL_COOKIE

protected static short SERIAL_COOKIE_NO_RUNCONTAINER

Fields
Modifier and Type	Field and Description
`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 RoaringArray()

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`advanceUntil(short x, int pos)` Find the smallest integer index larger than pos such that array[index].key>=x.
`protected void`	`append(RoaringArray sa, int startingIndex, int end)` Append the values from another array, no copy is made (use with care)
`protected void`	`append(short key, Container value)`
`protected void`	`appendCopiesAfter(RoaringArray sa, short beforeStart)` Append copies of the values AFTER a specified key (may or may not be present) to end.
`protected void`	`appendCopiesUntil(RoaringArray sourceArray, short stoppingKey)` Append copies of the values from another array, from the start
`protected void`	`appendCopy(RoaringArray sa, int index)` Append copy of the one value from another array
`protected void`	`appendCopy(RoaringArray sa, int startingIndex, int end)` Append copies of the values from another array
`protected void`	`clear()`
`RoaringArray`	`clone()`
`protected void`	`copyRange(int begin, int end, int newBegin)`
`void`	`deserialize(DataInput in)` Deserialize.
`boolean`	`equals(Object o)`
`protected void`	`extendArray(int k)`
`int`	`first()` Gets the first value in the array
`protected Container`	`getContainer(short x)`
`protected Container`	`getContainerAtIndex(int i)`
`ContainerPointer`	`getContainerPointer()` Create a ContainerPointer for this RoaringArray
`ContainerPointer`	`getContainerPointer(int startIndex)` Create a ContainerPointer for this RoaringArray
`protected int`	`getIndex(short x)`
`protected short`	`getKeyAtIndex(int i)`
`int`	`hashCode()`
`protected int`	`headerSize()`
`protected void`	`insertNewKeyValueAt(int i, short key, Container value)`
`int`	`last()` Gets the last value in the array
`void`	`readExternal(ObjectInput in)`
`protected void`	`removeAtIndex(int i)`
`protected void`	`removeIndexRange(int begin, int end)`
`protected void`	`replaceKeyAndContainerAtIndex(int i, short key, Container 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, Container c)`
`protected int`	`size()`
`void`	`writeExternal(ObjectOutput out)`

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

- Field Detail
  - 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
- Constructor Detail
  - RoaringArray
```
protected RoaringArray()
```
- Method Detail
  - advanceUntil
```
protected int advanceUntil(short x,
                           int pos)
```
    Find the smallest integer index larger than pos such that array[index].key>=x. If none can be found, return size. Based on code by O. Kaser.
    
    Parameters:
    
    x - minimal value
    
    pos - index to exceed
    
    Returns:
    
    the smallest index greater than pos such that array[index].key is at least as large as min, or size if it is not possible.
  - append
```
protected void append(short key,
                      Container value)
```
  - appendCopiesAfter
```
protected void appendCopiesAfter(RoaringArray sa,
                                 short beforeStart)
```
    Append copies of the values AFTER a specified key (may or may not be present) to end.
    
    Parameters:
    
    sa - other array
    
    beforeStart - given key is the largest key that we won't copy
  - appendCopiesUntil
```
protected void appendCopiesUntil(RoaringArray sourceArray,
                                 short stoppingKey)
```
    Append copies of the values from another array, from the start
    
    Parameters:
    
    sourceArray - The array to copy from
    
    stoppingKey - any equal or larger key in other array will terminate copying
  - appendCopy
```
protected void appendCopy(RoaringArray sa,
                          int index)
```
    Append copy of the one value from another array
    
    Parameters:
    
    sa - other array
    
    index - index in the other array
  - appendCopy
```
protected void appendCopy(RoaringArray sa,
                          int startingIndex,
                          int end)
```
    Append copies of the values from another array
    
    Parameters:
    
    sa - other array
    
    startingIndex - starting index in the other array
    
    end - endingIndex (exclusive) in the other array
  - append
```
protected void append(RoaringArray sa,
                      int startingIndex,
                      int end)
```
    Append the values from another array, no copy is made (use with care)
    
    Parameters:
    
    sa - other array
    
    startingIndex - starting index in the other array
    
    end - endingIndex (exclusive) in the other array
  - clear
```
protected void clear()
```
  - clone
```
public RoaringArray clone()
                   throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - copyRange
```
protected void copyRange(int begin,
                         int end,
                         int newBegin)
```
  - deserialize
```
public void deserialize(DataInput in)
                 throws IOException
```
    Deserialize.
    
    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
  - extendArray
```
protected void extendArray(int k)
```
  - getContainer
```
protected Container getContainer(short x)
```
  - getContainerAtIndex
```
protected Container getContainerAtIndex(int i)
```
  - getContainerPointer
```
public ContainerPointer getContainerPointer()
```
    Create a ContainerPointer for this RoaringArray
    
    Returns:
    
    a ContainerPointer
  - getContainerPointer
```
public ContainerPointer getContainerPointer(int startIndex)
```
    Create a ContainerPointer for this RoaringArray
    
    Parameters:
    
    startIndex - starting index in the container list
    
    Returns:
    
    a ContainerPointer
  - getIndex
```
protected int getIndex(short x)
```
  - getKeyAtIndex
```
protected short getKeyAtIndex(int i)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - headerSize
```
protected int headerSize()
```
  - insertNewKeyValueAt
```
protected void insertNewKeyValueAt(int i,
                                   short key,
                                   Container 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)
```
  - replaceKeyAndContainerAtIndex
```
protected void replaceKeyAndContainerAtIndex(int i,
                                             short key,
                                             Container c)
```
  - resize
```
protected void resize(int newLength)
```
  - serialize
```
public void serialize(DataOutput out)
               throws IOException
```
    Serialize. The current bitmap is not modified.
    
    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.
    
    Returns:
    
    the size in bytes
  - setContainerAtIndex
```
protected void setContainerAtIndex(int i,
                                   Container c)
```
  - size
```
protected int size()
```
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - first
```
public int first()
```
    Gets the first value in the array
    
    Returns:
    
    the first value in the array
    
    Throws:
    
    NoSuchElementException - if empty
  - last
```
public int last()
```
    Gets the last value in the array
    
    Returns:
    
    the last value in the array
    
    Throws:
    
    NoSuchElementException - if empty

Class RoaringArray

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIAL_COOKIE_NO_RUNCONTAINER

SERIAL_COOKIE

NO_OFFSET_THRESHOLD

Constructor Detail

RoaringArray

Method Detail

advanceUntil

append

appendCopiesAfter

appendCopiesUntil

appendCopy

appendCopy

append

clear

clone

copyRange

deserialize

equals

extendArray

getContainer

getContainerAtIndex

getContainerPointer

getContainerPointer

getIndex

getKeyAtIndex

hashCode

headerSize

insertNewKeyValueAt

readExternal

removeAtIndex

removeIndexRange

replaceKeyAndContainerAtIndex

resize

serialize

serializedSizeInBytes

setContainerAtIndex

size

writeExternal

first

last