RoaringArray (RoaringBitmap 0.9.27-bitlap API)

java.lang.Object
- org.bitlap.roaringbitmap.RoaringArray

所有已实现的接口:

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

另请参阅:

序列化表格

字段概要

字段
限定符和类型字段和说明

char[] keys

Container[] values

字段
限定符和类型	字段和说明
`char[]`	`keys`
`Container[]`	`values`

构造器概要

构造器
构造器和说明
`RoaringArray()`
`RoaringArray(char[] keys, Container[] values, int size)` create method with keys and containers
`RoaringArray(int initialCapacity)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`advanceUntil(char x, int pos)` Find the smallest integer index larger than pos such that array[index].key>=x.
`void`	`append(char key, Container value)` Appends the key and container to the storage, throws if the key is less than the current mark.
`void`	`append(RoaringArray sa, int startingIndex, int end)` Append the values from another array, no copy is made (use with care)
`void`	`clear()` clear
`RoaringArray`	`clone()`
`void`	`deserialize(java.nio.ByteBuffer bbf)` Deserialize (retrieve) this bitmap.
`void`	`deserialize(java.io.DataInput in)` Deserialize.
`void`	`deserialize(java.io.DataInput in, byte[] buffer)` Deserialize.
`boolean`	`equals(java.lang.Object o)`
`int`	`first()` Gets the first value in the array
`Container`	`getContainer(char x)` involves a binary search
`Container`	`getContainerAtIndex(int i)`
`int`	`getContainerIndex(char x)`
`ContainerPointer`	`getContainerPointer()` Create a ContainerPointer for this RoaringArray
`ContainerPointer`	`getContainerPointer(int startIndex)` Create a ContainerPointer for this RoaringArray
`char`	`getKeyAtIndex(int i)`
`int`	`hashCode()`
`int`	`last()` Gets the last value in the array
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`serialize(java.nio.ByteBuffer buffer)` Serialize.
`void`	`serialize(java.io.DataOutput out)` Serialize.
`int`	`serializedSizeInBytes()` Report the number of bytes required for serialization.
`int`	`size()`
`void`	`trim()` If possible, recover wasted memory.
`void`	`writeExternal(java.io.ObjectOutput out)`

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - keys
```
public char[] keys
```
  - values
```
public Container[] values
```
- 构造器详细资料
  - RoaringArray
```
public RoaringArray()
```
  - RoaringArray
```
public RoaringArray(int initialCapacity)
```
  - RoaringArray
```
public RoaringArray(char[] keys,
                    Container[] values,
                    int size)
```
    create method with keys and containers
- 方法详细资料
  - advanceUntil
```
public int advanceUntil(char 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.
    
    参数:
    
    x - minimal value
    
    pos - index to exceed
    
    返回:
    
    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
```
public void append(char key,
                   Container value)
```
    从接口复制的说明: AppendableStorage
    
    Appends the key and container to the storage, throws if the key is less than the current mark.
    
    指定者:
    
    append 在接口中 AppendableStorage<Container>
    
    参数:
    
    key - the key to append
    
    value - the data to append
  - append
```
public void append(RoaringArray sa,
                   int startingIndex,
                   int end)
```
    Append the values from another array, no copy is made (use with care)
    
    参数:
    
    sa - other array
    
    startingIndex - starting index in the other array
    
    end - endingIndex (exclusive) in the other array
  - clear
```
public void clear()
```
    clear
  - trim
```
public void trim()
```
    If possible, recover wasted memory.
  - clone
```
public RoaringArray clone()
                   throws java.lang.CloneNotSupportedException
```
    覆盖:
    
    clone 在类中 java.lang.Object
    
    抛出:
    
    java.lang.CloneNotSupportedException
  - deserialize
```
public void deserialize(java.io.DataInput in)
                 throws java.io.IOException
```
    Deserialize. If the DataInput is available as a byte[] or a ByteBuffer, you could prefer relying on deserialize(ByteBuffer). If the InputStream is >= 8kB, you could prefer relying on deserialize(DataInput, byte[]);
    
    参数:
    
    in - the DataInput stream
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
    
    InvalidRoaringFormat - if a Roaring Bitmap cookie is missing.
  - deserialize
```
public void deserialize(java.io.DataInput in,
                        byte[] buffer)
                 throws java.io.IOException
```
    Deserialize.
    
    参数:
    
    in - the DataInput stream
    
    buffer - The buffer gets overwritten with data during deserialization. You can pass a NULL reference as a buffer. A buffer containing at least 8192 bytes might be ideal for performance. It is recommended to reuse the buffer between calls to deserialize (in a single-threaded context) for best performance.
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
    
    InvalidRoaringFormat - if a Roaring Bitmap cookie is missing.
  - deserialize
```
public void deserialize(java.nio.ByteBuffer bbf)
```
    Deserialize (retrieve) this bitmap. See format specification at https://github.com/RoaringBitmap/RoaringFormatSpec The current bitmap is overwritten. It is not necessary that limit() on the input ByteBuffer indicates the end of the serialized data. After loading this RoaringBitmap, you can advance to the rest of the data (if there is more) by setting bbf.position(bbf.position() + bitmap.serializedSizeInBytes()); Note that the input ByteBuffer is effectively copied (with the slice operation) so you should expect the provided ByteBuffer position/mark/limit/order to remain unchanged.
    
    参数:
    
    bbf - the byte buffer (can be mapped, direct, array backed etc.
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - getContainer
```
public Container getContainer(char x)
```
    involves a binary search
  - getContainerIndex
```
public int getContainerIndex(char x)
```
  - getContainerAtIndex
```
public Container getContainerAtIndex(int i)
```
  - getContainerPointer
```
public ContainerPointer getContainerPointer()
```
    Create a ContainerPointer for this RoaringArray
    
    返回:
    
    a ContainerPointer
  - getContainerPointer
```
public ContainerPointer getContainerPointer(int startIndex)
```
    Create a ContainerPointer for this RoaringArray
    
    参数:
    
    startIndex - starting index in the container list
    
    返回:
    
    a ContainerPointer
  - getKeyAtIndex
```
public char getKeyAtIndex(int i)
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException
```
    指定者:
    
    readExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
  - serialize
```
public void serialize(java.io.DataOutput out)
               throws java.io.IOException
```
    Serialize. The current bitmap is not modified.
    
    参数:
    
    out - the DataOutput stream
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - serialize
```
public void serialize(java.nio.ByteBuffer buffer)
```
    Serialize. The current bitmap is not modified.
    
    参数:
    
    buffer - the ByteBuffer to write to
  - serializedSizeInBytes
```
public int serializedSizeInBytes()
```
    Report the number of bytes required for serialization.
    
    返回:
    
    the size in bytes
  - size
```
public int size()
```
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    指定者:
    
    writeExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
  - first
```
public int first()
```
    Gets the first value in the array
    
    返回:
    
    the first value in the array
    
    抛出:
    
    java.util.NoSuchElementException - if empty
  - last
```
public int last()
```
    Gets the last value in the array
    
    返回:
    
    the last value in the array
    
    抛出:
    
    java.util.NoSuchElementException - if empty

类 RoaringArray

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

keys

values

构造器详细资料

RoaringArray

RoaringArray

RoaringArray

方法详细资料

advanceUntil

append

append

clear

trim

clone

deserialize

deserialize

deserialize

equals

getContainer

getContainerIndex

getContainerAtIndex

getContainerPointer

getContainerPointer

getKeyAtIndex

hashCode

readExternal

serialize

serialize

serializedSizeInBytes

size

writeExternal

first

last