Roaring64Bitmap (RoaringBitmap 0.9.27-bitlap API)

java.lang.Object
- org.bitlap.roaringbitmap.longlong.Roaring64Bitmap

所有已实现的接口:

java.io.Externalizable, java.io.Serializable, ImmutableLongBitmapDataProvider, LongBitmapDataProvider
```
public class Roaring64Bitmap
extends java.lang.Object
implements java.io.Externalizable, LongBitmapDataProvider
```
Roaring64Bitmap is a compressed 64 bit bitmap. It can contain all the numbers of long rang[Long.MAX_VALUE, Long.MIN_VALUE]. Since java has no unsigned long,we treat the negative value as a successor of the positive value. So the ascending ordering of all the long value is: 0,1,2...Long.MAX_VALUE,Long.MIN_VALUE,Long.MIN_VALUE+1.......-1. See Long.toUnsignedString()

另请参阅:

序列化表格

嵌套类概要
- 从接口继承的嵌套类/接口 org.bitlap.roaringbitmap.longlong.ImmutableLongBitmapDataProvider
  ImmutableLongBitmapDataProvider.RoaringOfLong

构造器概要

构造器
构造器和说明

Roaring64Bitmap()

构造器
构造器和说明
`Roaring64Bitmap()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(long... dat)` Set all the specified values to true.
`void`	`add(long rangeStart, long rangeEnd)` Add to the current bitmap all longs in [rangeStart,rangeEnd).
`void`	`addInt(int x)`
`void`	`addLong(long x)` Add the value to the container (set the value to "true"), whether it already appears or not.
`void`	`and(Roaring64Bitmap x2)` In-place bitwise AND (intersection) operation.
`void`	`andNot(Roaring64Bitmap x2)` In-place bitwise ANDNOT (difference) operation.
`static Roaring64Bitmap`	`bitmapOf(long... dat)` Generate a bitmap with the specified values set to true.
`void`	`clear()` reset to an empty bitmap; result occupies as much space a newly created bitmap.
`Roaring64Bitmap`	`clone()`
`boolean`	`contains(long x)` Checks whether the value in included, which is equivalent to checking if the corresponding bit is set (get in BitSet class).
`void`	`deserialize(java.nio.ByteBuffer in)` Deserialize (retrieve) this bitmap.
`void`	`deserialize(java.io.DataInput in)` Deserialize (retrieve) this bitmap.
`boolean`	`equals(java.lang.Object obj)`
`void`	`flip(long x)` Add the value if it is not already present, otherwise remove it.
`void`	`flip(long rangeStart, long rangeEnd)` Complements the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive).
`void`	`forAllInRange(long start, int length, RelativeRangeConsumer rrc)` Consume presence information for all values in the range [start, start + length).
`void`	`forEach(LongConsumer lc)` Visit all values in the bitmap and pass them to the consumer
`void`	`forEachInRange(long start, int length, LongConsumer lc)` Consume each value present in the range [start, start + length).
`int`	`getIntCardinality()`
`long`	`getLongCardinality()` Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
`PeekableLongIterator`	`getLongIterator()` For better performance, consider the Use the `forEach` method.
`PeekableLongIterator`	`getLongIteratorFrom(long minval)` Produce an iterator over the values in this bitmap starting from `minval`.
`long`	`getLongSizeInBytes()` Estimate of the memory usage of this data structure.
`PeekableLongIterator`	`getReverseLongIterator()`
`PeekableLongIterator`	`getReverseLongIteratorFrom(long maxval)` Produce an iterator over the values in this bitmap starting from `maxval`.
`int`	`getSizeInBytes()` Estimate of the memory usage of this data structure.
`int`	`hashCode()`
`boolean`	`isEmpty()` Checks whether the bitmap is empty.
`java.util.Iterator<java.lang.Long>`	`iterator()` For better performance, consider the Use the `forEach` method.
`ImmutableLongBitmapDataProvider`	`limit(long x)` Create a new bitmap of the same class, containing at most maxcardinality integers.
`void`	`or(Roaring64Bitmap x2)` In-place bitwise OR (union) operation.
`long`	`rankLong(long id)` Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()).
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`removeLong(long x)` If present remove the specified integers (effectively, sets its bit value to false)
`boolean`	`runOptimize()` Use a run-length encoding where it is estimated as more space efficient
`long`	`select(long j)` Return the jth value stored in this bitmap.
`void`	`serialize(java.nio.ByteBuffer byteBuffer)` Serialize this bitmap, please make sure the size of the serialized bytes is smaller enough that ByteBuffer can hold it.
`void`	`serialize(java.io.DataOutput out)` Serialize this bitmap.
`long`	`serializedSizeInBytes()` Report the number of bytes required to serialize this bitmap.
`long[]`	`toArray()` Return the set values as an array, if the cardinality is smaller than 2147483648.
`java.lang.String`	`toString()` A string describing the bitmap.
`void`	`trim()` remove the allocated unused memory space
`void`	`writeExternal(java.io.ObjectOutput out)` `Roaring64NavigableMap` are serializable.
`void`	`xor(Roaring64Bitmap x2)` In-place bitwise XOR (symmetric difference) operation.

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

从接口继承的方法 org.bitlap.roaringbitmap.longlong.ImmutableLongBitmapDataProvider
reverseStream, stream

- 构造器详细资料
  - Roaring64Bitmap
```
public Roaring64Bitmap()
```
- 方法详细资料
  - addInt
```
public void addInt(int x)
```
  - addLong
```
public void addLong(long x)
```
    Add the value to the container (set the value to "true"), whether it already appears or not. Java lacks native unsigned longs but the x argument is considered to be unsigned. Within bitmaps, numbers are ordered according to Long.toUnsignedString(long, int). We order the numbers like 0, 1, ..., 9223372036854775807, -9223372036854775808, -9223372036854775807,..., -1.
    
    指定者:
    
    addLong 在接口中 LongBitmapDataProvider
    
    参数:
    
    x - long value
  - getLongCardinality
```
public long getLongCardinality()
```
    Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
    
    指定者:
    
    getLongCardinality 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    the cardinality
  - getIntCardinality
```
public int getIntCardinality()
                      throws java.lang.UnsupportedOperationException
```
    返回:
    
    the cardinality as an int
    
    抛出:
    
    java.lang.UnsupportedOperationException - if the cardinality does not fit in an int
  - select
```
public long select(long j)
            throws java.lang.IllegalArgumentException
```
    Return the jth value stored in this bitmap.
    
    指定者:
    
    select 在接口中 ImmutableLongBitmapDataProvider
    
    参数:
    
    j - index of the value
    
    返回:
    
    the value
    
    抛出:
    
    java.lang.IllegalArgumentException - if j is out of the bounds of the bitmap cardinality
  - iterator
```
public java.util.Iterator<java.lang.Long> iterator()
```
    For better performance, consider the Use the forEach method.
    
    返回:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - forEach
```
public void forEach(LongConsumer lc)
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    Visit all values in the bitmap and pass them to the consumer. * Usage:
```
 
  bitmap.forEach(new LongConsumer() {

    {@literal @}Override
    public void accept(long value) {
      // do something here
      
    }});
   
 }
 
```
    指定者:
    
    forEach 在接口中 ImmutableLongBitmapDataProvider
    
    参数:
    
    lc - the consumer
  - forAllInRange
```
public void forAllInRange(long start,
                          int length,
                          RelativeRangeConsumer rrc)
```
    Consume presence information for all values in the range [start, start + length).
    
    参数:
    
    start - Lower bound of values to consume.
    
    length - Maximum number of values to consume.
    
    rrc - Code to be executed for each present or absent value.
  - forEachInRange
```
public void forEachInRange(long start,
                           int length,
                           LongConsumer lc)
```
    Consume each value present in the range [start, start + length).
    
    参数:
    
    start - Lower bound of values to consume.
    
    length - Maximum number of values to consume.
    
    lc - Code to be executed for each present value.
  - rankLong
```
public long rankLong(long id)
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    
    Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()). The value is a full 64-bit value.
    
    指定者:
    
    rankLong 在接口中 ImmutableLongBitmapDataProvider
    
    参数:
    
    id - upper limit
    
    返回:
    
    the rank
  - or
```
public void or(Roaring64Bitmap x2)
```
    In-place bitwise OR (union) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - xor
```
public void xor(Roaring64Bitmap x2)
```
    In-place bitwise XOR (symmetric difference) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - and
```
public void and(Roaring64Bitmap x2)
```
    In-place bitwise AND (intersection) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - andNot
```
public void andNot(Roaring64Bitmap x2)
```
    In-place bitwise ANDNOT (difference) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - flip
```
public void flip(long rangeStart,
                 long rangeEnd)
```
    Complements the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive). The given bitmap is unchanged.
    
    参数:
    
    rangeStart - inclusive beginning of range, in [0, 0xffffffffffffffff]
    
    rangeEnd - exclusive ending of range, in [0, 0xffffffffffffffff + 1]
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Roaring64NavigableMap are serializable. However, contrary to RoaringBitmap, the serialization format is not well-defined: for now, it is strongly coupled with Java standard serialization. Just like the serialization may be incompatible between various Java versions, Roaring64NavigableMap are subject to incompatibilities. Moreover, even on a given Java versions, the serialization format may change from one RoaringBitmap version to another
    
    指定者:
    
    writeExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException
```
    指定者:
    
    readExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    A string describing the bitmap.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    the string
  - getLongIterator
```
public PeekableLongIterator getLongIterator()
```
    For better performance, consider the Use the forEach method.
    
    指定者:
    
    getLongIterator 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - getLongIteratorFrom
```
public PeekableLongIterator getLongIteratorFrom(long minval)
```
    Produce an iterator over the values in this bitmap starting from `minval`.
    
    参数:
    
    minval - the lower bound of the iterator returned
    
    返回:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - contains
```
public boolean contains(long x)
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    
    Checks whether the value in included, which is equivalent to checking if the corresponding bit is set (get in BitSet class).
    
    指定者:
    
    contains 在接口中 ImmutableLongBitmapDataProvider
    
    参数:
    
    x - long value
    
    返回:
    
    whether the long value is included.
  - getSizeInBytes
```
public int getSizeInBytes()
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    
    Estimate of the memory usage of this data structure. Internally, this is computed as a 64-bit counter.
    
    指定者:
    
    getSizeInBytes 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    estimated memory usage.
  - getLongSizeInBytes
```
public long getLongSizeInBytes()
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    
    Estimate of the memory usage of this data structure. Provides full 64-bit number.
    
    指定者:
    
    getLongSizeInBytes 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    estimated memory usage.
  - isEmpty
```
public boolean isEmpty()
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    
    Checks whether the bitmap is empty.
    
    指定者:
    
    isEmpty 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    true if this bitmap contains no set bit
  - limit
```
public ImmutableLongBitmapDataProvider limit(long x)
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    
    Create a new bitmap of the same class, containing at most maxcardinality integers.
    
    指定者:
    
    limit 在接口中 ImmutableLongBitmapDataProvider
    
    参数:
    
    x - maximal cardinality
    
    返回:
    
    a new bitmap with cardinality no more than maxcardinality
  - runOptimize
```
public boolean runOptimize()
```
    Use a run-length encoding where it is estimated as more space efficient
    
    返回:
    
    whether a change was applied
  - serialize
```
public void serialize(java.io.DataOutput out)
               throws java.io.IOException
```
    Serialize this bitmap. Unlike RoaringBitmap, there is no specification for now: it may change from one java version to another, and from one RoaringBitmap version to another. Consider calling runOptimize() before serialization to improve compression. The current bitmap is not modified.
    
    指定者:
    
    serialize 在接口中 ImmutableLongBitmapDataProvider
    
    参数:
    
    out - the DataOutput stream
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - serialize
```
public void serialize(java.nio.ByteBuffer byteBuffer)
               throws java.io.IOException
```
    Serialize this bitmap, please make sure the size of the serialized bytes is smaller enough that ByteBuffer can hold it.
    
    参数:
    
    byteBuffer - the ByteBuffer
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - deserialize
```
public void deserialize(java.io.DataInput in)
                 throws java.io.IOException
```
    Deserialize (retrieve) this bitmap. Unlike RoaringBitmap, there is no specification for now: it may change from one java version to another, and from one RoaringBitmap version to another. The current bitmap is overwritten.
    
    参数:
    
    in - the DataInput stream
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - deserialize
```
public void deserialize(java.nio.ByteBuffer in)
                 throws java.io.IOException
```
    Deserialize (retrieve) this bitmap. Unlike RoaringBitmap, there is no specification for now: it may change from one java version to another, and from one RoaringBitmap version to another. The current bitmap is overwritten.
    
    参数:
    
    in - the ByteBuffer stream
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - serializedSizeInBytes
```
public long serializedSizeInBytes()
```
    从接口复制的说明: ImmutableLongBitmapDataProvider
    
    Report the number of bytes required to serialize this bitmap. This is the number of bytes written out when using the serialize method. When using the writeExternal method, the count will be higher due to the overhead of Java serialization.
    
    指定者:
    
    serializedSizeInBytes 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    the size in bytes
  - clear
```
public void clear()
```
    reset to an empty bitmap; result occupies as much space a newly created bitmap.
  - toArray
```
public long[] toArray()
```
    Return the set values as an array, if the cardinality is smaller than 2147483648. The long values are in sorted order.
    
    指定者:
    
    toArray 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    array representing the set values.
  - bitmapOf
```
public static Roaring64Bitmap bitmapOf(long... dat)
```
    Generate a bitmap with the specified values set to true. The provided longs values don't have to be in sorted order, but it may be preferable to sort them from a performance point of view.
    
    参数:
    
    dat - set values
    
    返回:
    
    a new bitmap
  - add
```
public void add(long... dat)
```
    Set all the specified values to true. This can be expected to be slightly faster than calling "add" repeatedly. The provided integers values don't have to be in sorted order, but it may be preferable to sort them from a performance point of view.
    
    参数:
    
    dat - set values
  - add
```
public void add(long rangeStart,
                long rangeEnd)
```
    Add to the current bitmap all longs in [rangeStart,rangeEnd).
    
    参数:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - getReverseLongIterator
```
public PeekableLongIterator getReverseLongIterator()
```
    指定者:
    
    getReverseLongIterator 在接口中 ImmutableLongBitmapDataProvider
    
    返回:
    
    a custom iterator over set bits, the bits are traversed in descending sorted order
  - getReverseLongIteratorFrom
```
public PeekableLongIterator getReverseLongIteratorFrom(long maxval)
```
    Produce an iterator over the values in this bitmap starting from `maxval`.
    
    参数:
    
    maxval - the upper bound of the iterator returned
    
    返回:
    
    a custom iterator over set bits, the bits are traversed in descending sorted order
  - removeLong
```
public void removeLong(long x)
```
    从接口复制的说明: LongBitmapDataProvider
    
    If present remove the specified integers (effectively, sets its bit value to false)
    
    指定者:
    
    removeLong 在接口中 LongBitmapDataProvider
    
    参数:
    
    x - long value representing the index in a bitmap
  - trim
```
public void trim()
```
    remove the allocated unused memory space
    
    指定者:
    
    trim 在接口中 LongBitmapDataProvider
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - flip
```
public void flip(long x)
```
    Add the value if it is not already present, otherwise remove it.
    
    参数:
    
    x - long value
  - clone
```
public Roaring64Bitmap clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object

类 Roaring64Bitmap

嵌套类概要

从接口继承的嵌套类/接口 org.bitlap.roaringbitmap.longlong.ImmutableLongBitmapDataProvider

构造器概要

方法概要

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

从接口继承的方法 org.bitlap.roaringbitmap.longlong.ImmutableLongBitmapDataProvider

构造器详细资料

Roaring64Bitmap

方法详细资料

addInt

addLong

getLongCardinality

getIntCardinality

select

iterator

forEach

forAllInRange

forEachInRange

rankLong

or

xor

and

andNot

flip

writeExternal

readExternal

toString

getLongIterator

getLongIteratorFrom

contains

getSizeInBytes

getLongSizeInBytes

isEmpty

limit

runOptimize

serialize

serialize

deserialize

deserialize

serializedSizeInBytes

clear

toArray

bitmapOf

add

add

getReverseLongIterator

getReverseLongIteratorFrom

removeLong

trim

hashCode

equals

flip

clone