RoaringBitmap (RoaringBitmap 0.9.27-bitlap API)

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

所有已实现的接口:: java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Integer>, AppendableStorage<Container>, BitmapDataProvider, ImmutableBitmapDataProvider

直接已知子类:: FastRankRoaringBitmap

public class RoaringBitmap
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, java.lang.Iterable<java.lang.Integer>, java.io.Externalizable, ImmutableBitmapDataProvider, BitmapDataProvider, AppendableStorage<Container>

RoaringBitmap, a compressed alternative to the BitSet.

 
      import org.roaringbitmap.*;

      //...

      RoaringBitmap rr = RoaringBitmap.bitmapOf(1,2,3,1000);
      RoaringBitmap rr2 = new RoaringBitmap();
      for(int k = 4000; k<4255;++k) rr2.add(k);
      RoaringBitmap rror = RoaringBitmap.or(rr, rr2);

      //...
      DataOutputStream wheretoserialize = ...
      rr.runOptimize(); // can help compression
      rr.serialize(wheretoserialize);

Integers are added in unsigned sorted order. That is, they are treated as unsigned integers (see Java 8's Integer.toUnsignedLong function). Up to 4294967296 integers can be stored.

另请参阅:: 序列化表格

嵌套类概要
- 从接口继承的嵌套类/接口 org.bitlap.roaringbitmap.ImmutableBitmapDataProvider
  ImmutableBitmapDataProvider.RoaringOfInt

字段概要

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

RoaringArray highLowContainer

字段
限定符和类型	字段和说明
`RoaringArray`	`highLowContainer`

构造器概要

构造器
构造器和说明
`RoaringBitmap()` Create an empty bitmap
`RoaringBitmap(ImmutableRoaringBitmap rb)` Create a RoaringBitmap from a MutableRoaringBitmap or ImmutableRoaringBitmap.
`RoaringBitmap(RoaringArray highLowContainer)` Wrap an existing high low container

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`add(int... dat)` Set all the specified values to true.
`void`	`add(int x)` Add the value to the container (set the value to "true"), whether it already appears or not.
`void`	`add(int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`void`	`add(long rangeStart, long rangeEnd)` Add to the current bitmap all integers in [rangeStart,rangeEnd).
`static RoaringBitmap`	`add(RoaringBitmap rb, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`static RoaringBitmap`	`add(RoaringBitmap rb, long rangeStart, long rangeEnd)` Generate a new bitmap with all integers in [rangeStart,rangeEnd) added.
`void`	`addN(int[] dat, int offset, int n)` Set the specified values to true, within given boundaries.
`static RoaringBitmap`	`addOffset(RoaringBitmap x, long offset)` Generate a copy of the provided bitmap, but with all its values incremented by offset.
`static RoaringBitmap`	`and(java.util.Iterator<? extends RoaringBitmap> bitmaps, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative range end are illegal.
`static RoaringBitmap`	`and(java.util.Iterator<? extends RoaringBitmap> bitmaps, long rangeStart, long rangeEnd)` Computes AND between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
`void`	`and(RoaringBitmap x2)` In-place bitwise AND (intersection) operation.
`static RoaringBitmap`	`and(RoaringBitmap x1, RoaringBitmap x2)` Bitwise AND (intersection) operation.
`static int`	`andCardinality(RoaringBitmap x1, RoaringBitmap x2)` Cardinality of Bitwise AND (intersection) operation.
`void`	`andNot(RoaringBitmap x2)` In-place bitwise ANDNOT (difference) operation.
`static RoaringBitmap`	`andNot(RoaringBitmap x1, RoaringBitmap x2)` Bitwise ANDNOT (difference) operation.
`static RoaringBitmap`	`andNot(RoaringBitmap x1, RoaringBitmap x2, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative values for range endpoints are not allowed.
`static RoaringBitmap`	`andNot(RoaringBitmap x1, RoaringBitmap x2, long rangeStart, long rangeEnd)` Bitwise ANDNOT (difference) operation for the given range, rangeStart (inclusive) and rangeEnd (exclusive).
`static int`	`andNotCardinality(RoaringBitmap x1, RoaringBitmap x2)` Cardinality of the bitwise ANDNOT (left difference) operation.
`void`	`append(char key, Container container)` Appends the key and container to the storage, throws if the key is less than the current mark.
`static RoaringBitmap`	`bitmapOf(int... dat)` Generate a bitmap with the specified values set to true.
`static RoaringBitmap`	`bitmapOfRange(long min, long max)`
`static RoaringBitmap`	`bitmapOfUnordered(int... data)` Efficiently builds a RoaringBitmap from unordered data
`boolean`	`cardinalityExceeds(long threshold)` Returns true if the bitmap's cardinality exceeds the threshold.
`boolean`	`checkedAdd(int x)` Add the value to the container (set the value to "true"), whether it already appears or not.
`boolean`	`checkedRemove(int x)` If present remove the specified integer (effectively, sets its bit value to false)
`void`	`clear()` reset to an empty bitmap; result occupies as much space a newly created bitmap.
`RoaringBitmap`	`clone()`
`boolean`	`contains(int x)` Checks whether the value is included, which is equivalent to checking if the corresponding bit is set (get in BitSet class).
`boolean`	`contains(long minimum, long supremum)` Checks if the bitmap contains the range.
`boolean`	`contains(RoaringBitmap subset)` Checks whether the parameter is a subset of this RoaringBitmap or not
`void`	`deserialize(java.nio.ByteBuffer bbf)` Deserialize (retrieve) this bitmap.
`void`	`deserialize(java.io.DataInput in)` Deserialize (retrieve) this bitmap.
`void`	`deserialize(java.io.DataInput in, byte[] buffer)` Deserialize (retrieve) this bitmap.
`boolean`	`equals(java.lang.Object o)`
`int`	`first()` Get the first (smallest) integer in this RoaringBitmap, that is, returns the minimum of the set.
`void`	`flip(int x)` Add the value if it is not already present, otherwise remove it.
`void`	`flip(int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`void`	`flip(long rangeStart, long rangeEnd)` Modifies the current bitmap by complementing the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive).
`static RoaringBitmap`	`flip(RoaringBitmap rb, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`static RoaringBitmap`	`flip(RoaringBitmap bm, long rangeStart, long rangeEnd)` Complements the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive).
`void`	`forAllInRange(int start, int length, RelativeRangeConsumer rrc)` Consume presence information for all values in the range [start, start + length).
`void`	`forEach(IntConsumer ic)` Visit all values in the bitmap and pass them to the consumer
`void`	`forEachInRange(int start, int length, IntConsumer ic)` Consume each value present in the range [start, start + length).
`RoaringBatchIterator`	`getBatchIterator()` This iterator may be faster than others
`int`	`getCardinality()` Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
`ContainerPointer`	`getContainerPointer()` Return a low-level container pointer that can be used to access the underlying data structure.
`PeekableIntIterator`	`getIntIterator()` For better performance, consider the Use the `forEach` method.
`long`	`getLongCardinality()` Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
`long`	`getLongSizeInBytes()` Estimate of the memory usage of this data structure.
`IntIterator`	`getReverseIntIterator()`
`int`	`getSizeInBytes()` Estimate of the memory usage of this data structure.
`int`	`hashCode()` Compute the hashCode() of this bitmap.
`boolean`	`hasRunCompression()` Check whether this bitmap has had its runs compressed.
`boolean`	`intersects(long minimum, long supremum)` Checks if the range intersects with the bitmap.
`static boolean`	`intersects(RoaringBitmap x1, RoaringBitmap x2)` Checks whether the two bitmaps intersect.
`boolean`	`isEmpty()` Checks whether the bitmap is empty.
`boolean`	`isHammingSimilar(RoaringBitmap other, int tolerance)` Returns true if the other bitmap has no more than tolerance bits differing from this bitmap.
`java.util.Iterator<java.lang.Integer>`	`iterator()` iterate over the positions of the true values.
`int`	`last()` Get the last (largest) integer in this RoaringBitmap, that is, returns the maximum of the set.
`protected void`	`lazyor(RoaringBitmap x2)`
`protected static RoaringBitmap`	`lazyor(RoaringBitmap x1, RoaringBitmap x2)`
`protected static RoaringBitmap`	`lazyorfromlazyinputs(RoaringBitmap x1, RoaringBitmap x2)`
`RoaringBitmap`	`limit(int maxcardinality)` Create a new Roaring bitmap containing at most maxcardinality integers.
`static long`	`maximumSerializedSize(long cardinality, long universe_size)` Assume that one wants to store "cardinality" integers in [0, universe_size), this function returns an upper bound on the serialized size in bytes.
`protected void`	`naivelazyor(RoaringBitmap x2)`
`long`	`nextAbsentValue(int fromValue)` Returns the first absent value equal to or larger than the provided value (interpreted as an unsigned integer).
`long`	`nextValue(int fromValue)` Returns the first value equal to or larger than the provided value (interpreted as an unsigned integer).
`static RoaringBitmap`	`or(java.util.Iterator<? extends RoaringBitmap> bitmaps)` Compute overall OR between bitmaps.
`static RoaringBitmap`	`or(java.util.Iterator<? extends RoaringBitmap> bitmaps, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative range points are forbidden.
`static RoaringBitmap`	`or(java.util.Iterator<? extends RoaringBitmap> bitmaps, long rangeStart, long rangeEnd)` Computes OR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
`static RoaringBitmap`	`or(RoaringBitmap... bitmaps)` Compute overall OR between bitmaps.
`void`	`or(RoaringBitmap x2)` In-place bitwise OR (union) operation.
`static RoaringBitmap`	`or(RoaringBitmap x1, RoaringBitmap x2)` Bitwise OR (union) operation.
`static int`	`orCardinality(RoaringBitmap x1, RoaringBitmap x2)` Cardinality of the bitwise OR (union) operation.
`void`	`orNot(RoaringBitmap other, long rangeEnd)` In-place bitwise ORNOT operation.
`static RoaringBitmap`	`orNot(RoaringBitmap x1, RoaringBitmap x2, long rangeEnd)` Bitwise ORNOT operation for the given range, rangeStart (inclusive) and rangeEnd (exclusive).
`long`	`previousAbsentValue(int fromValue)` Returns the first absent value less than or equal to the provided value (interpreted as an unsigned integer).
`long`	`previousValue(int fromValue)` Returns the first value less than or equal to the provided value (interpreted as an unsigned integer).
`long`	`rangeCardinality(long start, long end)` Computes the number of values in the interval [start,end) where start is included and end excluded.
`int`	`rank(int x)` Rank returns the number of integers that are smaller or equal to x (rank(infinity) would be getCardinality()).
`long`	`rankLong(int x)` 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`	`remove(int x)` If present remove the specified integer (effectively, sets its bit value to false)
`void`	`remove(int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`void`	`remove(long rangeStart, long rangeEnd)` Remove from the current bitmap all integers in [rangeStart,rangeEnd).
`static RoaringBitmap`	`remove(RoaringBitmap rb, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`static RoaringBitmap`	`remove(RoaringBitmap rb, long rangeStart, long rangeEnd)` Generate a new bitmap with all integers in [rangeStart,rangeEnd) removed.
`boolean`	`removeRunCompression()` Remove run-length encoding even when it is more space efficient
`protected void`	`repairAfterLazy()`
`boolean`	`runOptimize()` Use a run-length encoding where it is more space efficient
`int`	`select(int j)` Return the jth value stored in this bitmap.
`void`	`serialize(java.nio.ByteBuffer buffer)` Serialize this bitmap to a ByteBuffer.
`void`	`serialize(java.io.DataOutput out)` Serialize this bitmap.
`int`	`serializedSizeInBytes()` Report the number of bytes required to serialize this bitmap.
`int[]`	`toArray()` Return the set values as an array, if the cardinality is smaller than 2147483648.
`MutableRoaringBitmap`	`toMutableRoaringBitmap()` Convert (copies) to a mutable roaring bitmap.
`java.lang.String`	`toString()` A string describing the bitmap.
`void`	`trim()` Recover allocated but unused memory.
`void`	`writeExternal(java.io.ObjectOutput out)`
`static RoaringBitmap`	`xor(java.util.Iterator<? extends RoaringBitmap> bitmaps, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative values not allowed for rangeStart and rangeEnd
`static RoaringBitmap`	`xor(java.util.Iterator<? extends RoaringBitmap> bitmaps, long rangeStart, long rangeEnd)` Computes XOR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
`void`	`xor(RoaringBitmap x2)` In-place bitwise XOR (symmetric difference) operation.
`static RoaringBitmap`	`xor(RoaringBitmap x1, RoaringBitmap x2)` Bitwise XOR (symmetric difference) operation.
`static int`	`xorCardinality(RoaringBitmap x1, RoaringBitmap x2)` Cardinality of the bitwise XOR (symmetric difference) operation.

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

从接口继承的方法 java.lang.Iterable
forEach, spliterator

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

- 字段详细资料
  - highLowContainer
```
public RoaringArray highLowContainer
```
- 构造器详细资料
  - RoaringBitmap
```
public RoaringBitmap()
```
    Create an empty bitmap
  - RoaringBitmap
```
public RoaringBitmap(RoaringArray highLowContainer)
```
    Wrap an existing high low container
  - RoaringBitmap
```
public RoaringBitmap(ImmutableRoaringBitmap rb)
```
    Create a RoaringBitmap from a MutableRoaringBitmap or ImmutableRoaringBitmap. The source is not modified.
    
    参数:
    
    rb - the original bitmap
- 方法详细资料
  - addOffset
```
public static RoaringBitmap addOffset(RoaringBitmap x,
                                      long offset)
```
    Generate a copy of the provided bitmap, but with all its values incremented by offset. The parameter offset can be negative. Values that would fall outside of the valid 32-bit range are discarded so that the result can have lower cardinality. This method can be relatively expensive when offset is not divisible by 65536. Use sparingly.
    
    参数:
    
    x - source bitmap
    
    offset - increment
    
    返回:
    
    a new bitmap
  - add
```
public static RoaringBitmap add(RoaringBitmap rb,
                                long rangeStart,
                                long rangeEnd)
```
    Generate a new bitmap with all integers in [rangeStart,rangeEnd) added.
    
    参数:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new bitmap
  - add
```
@Deprecated
public static RoaringBitmap add(RoaringBitmap rb,
                                            int rangeStart,
                                            int rangeEnd)
```
    已过时。 use the version where longs specify the range
    
    Generate a new bitmap with all integers in [rangeStart,rangeEnd) added.
    
    参数:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new bitmap
  - and
```
public static RoaringBitmap and(RoaringBitmap x1,
                                RoaringBitmap x2)
```
    Bitwise AND (intersection) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged. If you have more than 2 bitmaps, consider using the FastAggregation class.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    result of the operation
    
    另请参阅:
    
    FastAggregation.and(RoaringBitmap...)
  - andCardinality
```
public static int andCardinality(RoaringBitmap x1,
                                 RoaringBitmap x2)
```
    Cardinality of Bitwise AND (intersection) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    as if you did and(x2,x2).getCardinality()
    
    另请参阅:
    
    FastAggregation.and(RoaringBitmap...)
  - andNot
```
public static RoaringBitmap andNot(RoaringBitmap x1,
                                   RoaringBitmap x2)
```
    Bitwise ANDNOT (difference) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    result of the operation
  - add
```
public void add(int... 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
  - addN
```
public void addN(int[] dat,
                 int offset,
                 int n)
```
    Set the specified values to true, within given boundaries. This can be expected to be slightly faster than calling "add" repeatedly on the values dat[offset], dat[offset+1],..., dat[offset+n-1]. 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
    
    offset - from which index the values should be set to true
    
    n - how many values should be set to true
  - bitmapOf
```
public static RoaringBitmap bitmapOf(int... dat)
```
    Generate a bitmap with the specified values set to true. 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
    
    返回:
    
    a new bitmap
  - bitmapOfUnordered
```
public static RoaringBitmap bitmapOfUnordered(int... data)
```
    Efficiently builds a RoaringBitmap from unordered data
    
    参数:
    
    data - unsorted data
    
    返回:
    
    a new bitmap
  - bitmapOfRange
```
public static RoaringBitmap bitmapOfRange(long min,
                                          long max)
```
    另请参阅:
    
    add(long, long)
  - flip
```
public static RoaringBitmap flip(RoaringBitmap bm,
                                 long rangeStart,
                                 long rangeEnd)
```
    Complements the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive). The given bitmap is unchanged.
    
    参数:
    
    bm - bitmap being negated
    
    rangeStart - inclusive beginning of range, in [0, 0xffffffff]
    
    rangeEnd - exclusive ending of range, in [0, 0xffffffff + 1]
    
    返回:
    
    a new Bitmap
  - flip
```
@Deprecated
public static RoaringBitmap flip(RoaringBitmap rb,
                                             int rangeStart,
                                             int rangeEnd)
```
    已过时。 use the version where longs specify the range
    
    Complements the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive). The given bitmap is unchanged.
    
    参数:
    
    rb - bitmap being negated
    
    rangeStart - inclusive beginning of range, in [0, 0xffffffff]
    
    rangeEnd - exclusive ending of range, in [0, 0xffffffff + 1]
    
    返回:
    
    a new Bitmap
  - intersects
```
public static boolean intersects(RoaringBitmap x1,
                                 RoaringBitmap x2)
```
    Checks whether the two bitmaps intersect. This can be much faster than calling "and" and checking the cardinality of the result.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    true if they intersect
  - lazyor
```
protected static RoaringBitmap lazyor(RoaringBitmap x1,
                                      RoaringBitmap x2)
```
  - lazyorfromlazyinputs
```
protected static RoaringBitmap lazyorfromlazyinputs(RoaringBitmap x1,
                                                    RoaringBitmap x2)
```
  - or
```
public static RoaringBitmap or(java.util.Iterator<? extends RoaringBitmap> bitmaps)
```
    Compute overall OR between bitmaps. (Effectively calls FastAggregation.or(java.util.Iterator<? extends org.bitlap.roaringbitmap.RoaringBitmap>))
    
    参数:
    
    bitmaps - input bitmaps
    
    返回:
    
    aggregated bitmap
  - or
```
public static RoaringBitmap or(RoaringBitmap... bitmaps)
```
    Compute overall OR between bitmaps. (Effectively calls FastAggregation.or(java.util.Iterator<? extends org.bitlap.roaringbitmap.RoaringBitmap>))
    
    参数:
    
    bitmaps - input bitmaps
    
    返回:
    
    aggregated bitmap
  - or
```
public static RoaringBitmap or(RoaringBitmap x1,
                               RoaringBitmap x2)
```
    Bitwise OR (union) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged. If you have more than 2 bitmaps, consider using the FastAggregation class.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    result of the operation
    
    另请参阅:
    
    FastAggregation.or(RoaringBitmap...), FastAggregation.horizontal_or(RoaringBitmap...)
  - orCardinality
```
public static int orCardinality(RoaringBitmap x1,
                                RoaringBitmap x2)
```
    Cardinality of the bitwise OR (union) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged. If you have more than 2 bitmaps, consider using the FastAggregation class.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    cardinality of the union
    
    另请参阅:
    
    FastAggregation.or(RoaringBitmap...), FastAggregation.horizontal_or(RoaringBitmap...)
  - xorCardinality
```
public static int xorCardinality(RoaringBitmap x1,
                                 RoaringBitmap x2)
```
    Cardinality of the bitwise XOR (symmetric difference) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    cardinality of the symmetric difference
  - andNotCardinality
```
public static int andNotCardinality(RoaringBitmap x1,
                                    RoaringBitmap x2)
```
    Cardinality of the bitwise ANDNOT (left difference) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    cardinality of the left difference
  - remove
```
public static RoaringBitmap remove(RoaringBitmap rb,
                                   long rangeStart,
                                   long rangeEnd)
```
    Generate a new bitmap with all integers in [rangeStart,rangeEnd) removed.
    
    参数:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new bitmap
  - remove
```
@Deprecated
public static RoaringBitmap remove(RoaringBitmap rb,
                                               int rangeStart,
                                               int rangeEnd)
```
    已过时。 use the version where longs specify the range
    
    Generate a new bitmap with all integers in [rangeStart,rangeEnd) removed.
    
    参数:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new bitmap
  - xor
```
public static RoaringBitmap xor(RoaringBitmap x1,
                                RoaringBitmap x2)
```
    Bitwise XOR (symmetric difference) operation. The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged. If you have more than 2 bitmaps, consider using the FastAggregation class.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    result of the operation
    
    另请参阅:
    
    FastAggregation.xor(RoaringBitmap...), FastAggregation.horizontal_xor(RoaringBitmap...)
  - add
```
public void add(int x)
```
    Add the value to the container (set the value to "true"), whether it already appears or not. Java lacks native unsigned integers but the x argument is considered to be unsigned. Within bitmaps, numbers are ordered according to Integer.compareUnsigned(int, int). We order the numbers like 0, 1, ..., 2147483647, -2147483648, -2147483647,..., -1.
    
    指定者:
    
    add 在接口中 BitmapDataProvider
    
    参数:
    
    x - integer value
  - add
```
public void add(long rangeStart,
                long rangeEnd)
```
    Add to the current bitmap all integers in [rangeStart,rangeEnd).
    
    指定者:
    
    add 在接口中 BitmapDataProvider
    
    参数:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - add
```
@Deprecated
public void add(int rangeStart,
                            int rangeEnd)
```
    已过时。 use the version where longs specify the range
    
    Add to the current bitmap all integers in [rangeStart,rangeEnd).
    
    参数:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - intersects
```
public boolean intersects(long minimum,
                          long supremum)
```
    Checks if the range intersects with the bitmap.
    
    参数:
    
    minimum - the inclusive unsigned lower bound of the range
    
    supremum - the exclusive unsigned upper bound of the range
    
    返回:
    
    whether the bitmap intersects with the range
  - and
```
public void and(RoaringBitmap x2)
```
    In-place bitwise AND (intersection) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - and
```
public static RoaringBitmap and(java.util.Iterator<? extends RoaringBitmap> bitmaps,
                                long rangeStart,
                                long rangeEnd)
```
    Computes AND between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    参数:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new result bitmap
  - and
```
@Deprecated
public static RoaringBitmap and(java.util.Iterator<? extends RoaringBitmap> bitmaps,
                                            int rangeStart,
                                            int rangeEnd)
```
    已过时。 use the version where longs specify the range. Negative range end are illegal.
    
    Computes AND between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    参数:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new result bitmap
  - andNot
```
public void andNot(RoaringBitmap x2)
```
    In-place bitwise ANDNOT (difference) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - andNot
```
public static RoaringBitmap andNot(RoaringBitmap x1,
                                   RoaringBitmap x2,
                                   long rangeStart,
                                   long rangeEnd)
```
    Bitwise ANDNOT (difference) operation for the given range, rangeStart (inclusive) and rangeEnd (exclusive). The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    rangeStart - starting point of the range (inclusive)
    
    rangeEnd - end point of the range (exclusive)
    
    返回:
    
    result of the operation
  - andNot
```
@Deprecated
public static RoaringBitmap andNot(RoaringBitmap x1,
                                               RoaringBitmap x2,
                                               int rangeStart,
                                               int rangeEnd)
```
    已过时。 use the version where longs specify the range. Negative values for range endpoints are not allowed.
    
    Bitwise ANDNOT (difference) operation for the given range, rangeStart (inclusive) and rangeEnd (exclusive). The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    rangeStart - starting point of the range (inclusive)
    
    rangeEnd - end point of the range (exclusive)
    
    返回:
    
    result of the operation
  - orNot
```
public void orNot(RoaringBitmap other,
                  long rangeEnd)
```
    In-place bitwise ORNOT operation. The current bitmap is modified.
    
    参数:
    
    other - the other bitmap
    
    rangeEnd - end point of the range (exclusive).
  - orNot
```
public static RoaringBitmap orNot(RoaringBitmap x1,
                                  RoaringBitmap x2,
                                  long rangeEnd)
```
    Bitwise ORNOT operation for the given range, rangeStart (inclusive) and rangeEnd (exclusive). The provided bitmaps are *not* modified. This operation is thread-safe as long as the provided bitmaps remain unchanged.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    rangeEnd - end point of the range (exclusive)
    
    返回:
    
    result of the operation
  - checkedAdd
```
public boolean checkedAdd(int x)
```
    Add the value to the container (set the value to "true"), whether it already appears or not.
    
    参数:
    
    x - integer value
    
    返回:
    
    true if the added int wasn't already contained in the bitmap. False otherwise.
  - checkedRemove
```
public boolean checkedRemove(int x)
```
    If present remove the specified integer (effectively, sets its bit value to false)
    
    参数:
    
    x - integer value representing the index in a bitmap
    
    返回:
    
    true if the unset bit was already in the bitmap
  - clear
```
public void clear()
```
    reset to an empty bitmap; result occupies as much space a newly created bitmap.
  - clone
```
public RoaringBitmap clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
  - contains
```
public boolean contains(int x)
```
    Checks whether the value is included, which is equivalent to checking if the corresponding bit is set (get in BitSet class).
    
    指定者:
    
    contains 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    x - integer value
    
    返回:
    
    whether the integer value is included.
  - contains
```
public boolean contains(long minimum,
                        long supremum)
```
    Checks if the bitmap contains the range.
    
    参数:
    
    minimum - the inclusive lower bound of the range
    
    supremum - the exclusive upper bound of the range
    
    返回:
    
    whether the bitmap contains the range
  - deserialize
```
public void deserialize(java.io.DataInput in,
                        byte[] buffer)
                 throws java.io.IOException
```
    Deserialize (retrieve) this bitmap. See format specification at https://github.com/RoaringBitmap/RoaringFormatSpec The current bitmap is overwritten.
    
    参数:
    
    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.
  - deserialize
```
public void deserialize(java.io.DataInput in)
                 throws java.io.IOException
```
    Deserialize (retrieve) this bitmap. See format specification at https://github.com/RoaringBitmap/RoaringFormatSpec 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 bbf)
                 throws java.io.IOException
```
    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 to remain unchanged.
    
    参数:
    
    bbf - the byte buffer (can be mapped, direct, array backed etc.
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - isHammingSimilar
```
public boolean isHammingSimilar(RoaringBitmap other,
                                int tolerance)
```
    Returns true if the other bitmap has no more than tolerance bits differing from this bitmap. The other may be transformed into a bitmap equal to this bitmap in no more than tolerance bit flips if this method returns true.
    
    参数:
    
    other - the bitmap to compare to
    
    tolerance - the maximum number of bits that may differ
    
    返回:
    
    true if the number of differing bits is smaller than tolerance
  - flip
```
public void flip(int x)
```
    Add the value if it is not already present, otherwise remove it.
    
    参数:
    
    x - integer value
  - flip
```
public void flip(long rangeStart,
                 long rangeEnd)
```
    Modifies the current bitmap by complementing the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive).
    
    参数:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - flip
```
@Deprecated
public void flip(int rangeStart,
                             int rangeEnd)
```
    已过时。 use the version where longs specify the range
    
    Modifies the current bitmap by complementing the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive).
    
    参数:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - getLongCardinality
```
public long getLongCardinality()
```
    Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
    
    指定者:
    
    getLongCardinality 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    the cardinality
  - getCardinality
```
public int getCardinality()
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    Returns the number of distinct integers added to the bitmap (e.g., number of bits set). Internally, this is computed as a 64-bit number.
    
    指定者:
    
    getCardinality 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    the cardinality
  - cardinalityExceeds
```
public boolean cardinalityExceeds(long threshold)
```
    Returns true if the bitmap's cardinality exceeds the threshold.
    
    参数:
    
    threshold - threshold
    
    返回:
    
    true if the cardinality exceeds the threshold.
  - forEach
```
public void forEach(IntConsumer ic)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    Visit all values in the bitmap and pass them to the consumer. * Usage:
```
 
  bitmap.forEach(new IntConsumer() {

    {@literal @}Override
    public void accept(int value) {
      // do something here
      
    }});
   
 }
 
```
    指定者:
    
    forEach 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    ic - the consumer
  - forAllInRange
```
public void forAllInRange(int 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(int start,
                           int length,
                           IntConsumer ic)
```
    Consume each value present in the range [start, start + length).
    
    参数:
    
    start - Lower bound of values to consume.
    
    length - Maximum number of values to consume.
    
    ic - Code to be executed for each present value.
  - getContainerPointer
```
public ContainerPointer getContainerPointer()
```
    Return a low-level container pointer that can be used to access the underlying data structure.
    
    返回:
    
    container pointer
  - getIntIterator
```
public PeekableIntIterator getIntIterator()
```
    For better performance, consider the Use the forEach method.
    
    指定者:
    
    getIntIterator 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - getReverseIntIterator
```
public IntIterator getReverseIntIterator()
```
    指定者:
    
    getReverseIntIterator 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    a custom iterator over set bits, the bits are traversed in descending sorted order
  - getBatchIterator
```
public RoaringBatchIterator getBatchIterator()
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    This iterator may be faster than others
    
    指定者:
    
    getBatchIterator 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    iterator which works on batches of data.
  - getLongSizeInBytes
```
public long getLongSizeInBytes()
```
    Estimate of the memory usage of this data structure. This can be expected to be within 1% of the true memory usage in common usage scenarios. If exact measures are needed, we recommend using dedicated libraries such as ehcache-sizeofengine. In adversarial cases, this estimate may be 10x the actual memory usage. For example, if you insert a single random value in a bitmap, then over a 100 bytes may be used by the JVM whereas this function may return an estimate of 32 bytes. The same will be true in the "sparse" scenario where you have a small set of random-looking integers spanning a wide range of values. These are considered adversarial cases because, as a general rule, if your data looks like a set of random integers, Roaring bitmaps are probably not the right data structure. Note that you can serialize your Roaring Bitmaps to disk and then construct ImmutableRoaringBitmap instances from a ByteBuffer. In such cases, the Java heap usage will be significantly less than what is reported. If your main goal is to compress arrays of integers, there are other libraries that are maybe more appropriate such as JavaFastPFOR. Note, however, that in general, random integers (as produced by random number generators or hash functions) are not compressible. Trying to compress random data is an adversarial use case.
    
    指定者:
    
    getLongSizeInBytes 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    estimated memory usage.
    
    另请参阅:
    
    JavaFastPFOR
  - getSizeInBytes
```
public int getSizeInBytes()
```
    Estimate of the memory usage of this data structure. This can be expected to be within 1% of the true memory usage in common usage scenarios. If exact measures are needed, we recommend using dedicated libraries such as ehcache-sizeofengine. In adversarial cases, this estimate may be 10x the actual memory usage. For example, if you insert a single random value in a bitmap, then over a 100 bytes may be used by the JVM whereas this function may return an estimate of 32 bytes. The same will be true in the "sparse" scenario where you have a small set of random-looking integers spanning a wide range of values. These are considered adversarial cases because, as a general rule, if your data looks like a set of random integers, Roaring bitmaps are probably not the right data structure. Note that you can serialize your Roaring Bitmaps to disk and then construct ImmutableRoaringBitmap instances from a ByteBuffer. In such cases, the Java heap usage will be significantly less than what is reported. If your main goal is to compress arrays of integers, there are other libraries that are maybe more appropriate such as JavaFastPFOR. Note, however, that in general, random integers (as produced by random number generators or hash functions) are not compressible. Trying to compress random data is an adversarial use case.
    
    指定者:
    
    getSizeInBytes 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    estimated memory usage.
    
    另请参阅:
    
    JavaFastPFOR
  - hashCode
```
public int hashCode()
```
    Compute the hashCode() of this bitmap. For performance reasons, this method deliberately violates the Java contract regarding hashCode/equals in the following manner: If the two bitmaps are equal *and* they have the same hasRunCompression() result, then they have the same hashCode(). Thus, for the Java contract to be satisfied, you should either call runOptimize() on all your bitmaps, or on none of your bitmaps.
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    the hash code
  - hasRunCompression
```
public boolean hasRunCompression()
```
    Check whether this bitmap has had its runs compressed.
    
    返回:
    
    whether this bitmap has run compression
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether the bitmap is empty.
    
    指定者:
    
    isEmpty 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    true if this bitmap contains no set bit
  - iterator
```
public java.util.Iterator<java.lang.Integer> iterator()
```
    iterate over the positions of the true values.
    
    指定者:
    
    iterator 在接口中 java.lang.Iterable<java.lang.Integer>
    
    返回:
    
    the iterator
  - lazyor
```
protected void lazyor(RoaringBitmap x2)
```
  - naivelazyor
```
protected void naivelazyor(RoaringBitmap x2)
```
  - limit
```
public RoaringBitmap limit(int maxcardinality)
```
    Create a new Roaring bitmap containing at most maxcardinality integers.
    
    指定者:
    
    limit 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    maxcardinality - maximal cardinality
    
    返回:
    
    a new bitmap with cardinality no more than maxcardinality
  - or
```
public void or(RoaringBitmap x2)
```
    In-place bitwise OR (union) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - or
```
public static RoaringBitmap or(java.util.Iterator<? extends RoaringBitmap> bitmaps,
                               long rangeStart,
                               long rangeEnd)
```
    Computes OR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    参数:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new result bitmap
  - or
```
@Deprecated
public static RoaringBitmap or(java.util.Iterator<? extends RoaringBitmap> bitmaps,
                                           int rangeStart,
                                           int rangeEnd)
```
    已过时。 use the version where longs specify the range. Negative range points are forbidden.
    
    Computes OR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    参数:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new result bitmap
  - rankLong
```
public long rankLong(int x)
```
    Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()). If you provide the smallest value as a parameter, this function will return 1. If provide a value smaller than the smallest value, it will return 0.
    
    指定者:
    
    rankLong 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    x - upper limit
    
    返回:
    
    the rank
    
    另请参阅:
    
    Ranking in statistics
  - rangeCardinality
```
public long rangeCardinality(long start,
                             long end)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    Computes the number of values in the interval [start,end) where start is included and end excluded. rangeCardinality(0,0x100000000) provides the total cardinality (getLongCardinality). The answer is a 64-bit value between 1 and 0x100000000.
    
    指定者:
    
    rangeCardinality 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    start - lower limit (included)
    
    end - upper limit (excluded)
    
    返回:
    
    the number of elements in [start,end), between 0 and 0x100000000.
  - rank
```
public int rank(int x)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    Rank returns the number of integers that are smaller or equal to x (rank(infinity) would be getCardinality()). If you provide the smallest value as a parameter, this function will return 1. If provide a value smaller than the smallest value, it will return 0. The value is internally computed as a 64-bit number.
    
    指定者:
    
    rank 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    x - upper limit
    
    返回:
    
    the rank
    
    另请参阅:
    
    Ranking in statistics
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException
```
    指定者:
    
    readExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
  - remove
```
public void remove(int x)
```
    If present remove the specified integer (effectively, sets its bit value to false)
    
    指定者:
    
    remove 在接口中 BitmapDataProvider
    
    参数:
    
    x - integer value representing the index in a bitmap
  - remove
```
public void remove(long rangeStart,
                   long rangeEnd)
```
    Remove from the current bitmap all integers in [rangeStart,rangeEnd).
    
    参数:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - remove
```
@Deprecated
public void remove(int rangeStart,
                               int rangeEnd)
```
    已过时。 use the version where longs specify the range
    
    Remove from the current bitmap all integers in [rangeStart,rangeEnd).
    
    参数:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - removeRunCompression
```
public boolean removeRunCompression()
```
    Remove run-length encoding even when it is more space efficient
    
    返回:
    
    whether a change was applied
  - repairAfterLazy
```
protected void repairAfterLazy()
```
  - runOptimize
```
public boolean runOptimize()
```
    Use a run-length encoding where it is more space efficient
    
    返回:
    
    whether a change was applied
  - contains
```
public boolean contains(RoaringBitmap subset)
```
    Checks whether the parameter is a subset of this RoaringBitmap or not
    
    参数:
    
    subset - the potential subset
    
    返回:
    
    true if the parameter is a subset of this RoaringBitmap
  - select
```
public int select(int j)
```
    Return the jth value stored in this bitmap. The provided value needs to be smaller than the cardinality otherwise an IllegalArgumentException exception is thrown. The smallest value is at index 0. Note that this function differs in convention from the rank function which returns 1 when ranking the smallest value.
    
    指定者:
    
    select 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    j - index of the value
    
    返回:
    
    the value
    
    另请参阅:
    
    Selection algorithm
  - nextValue
```
public long nextValue(int fromValue)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    Returns the first value equal to or larger than the provided value (interpreted as an unsigned integer). If no such bit exists then -1 is returned. It is not necessarily a computationally effective way to iterate through the values.
    
    指定者:
    
    nextValue 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    fromValue - the lower bound (inclusive)
    
    返回:
    
    the smallest value larger than or equal to the specified value, or -1 if there is no such value
  - previousValue
```
public long previousValue(int fromValue)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    Returns the first value less than or equal to the provided value (interpreted as an unsigned integer). If no such bit exists then -1 is returned. It is not an efficient way to iterate through the values backwards.
    
    指定者:
    
    previousValue 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    fromValue - the upper bound (inclusive)
    
    返回:
    
    the largest value less than or equal to the specified value, or -1 if there is no such value
  - nextAbsentValue
```
public long nextAbsentValue(int fromValue)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    Returns the first absent value equal to or larger than the provided value (interpreted as an unsigned integer). It is not necessarily a computationally effective way to iterate through the values.
    
    指定者:
    
    nextAbsentValue 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    fromValue - the lower bound (inclusive)
    
    返回:
    
    the smallest absent value larger than or equal to the specified value.
  - previousAbsentValue
```
public long previousAbsentValue(int fromValue)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    
    Returns the first absent value less than or equal to the provided value (interpreted as an unsigned integer). It is not necessarily a computationally effective way to iterate through the values.
    
    指定者:
    
    previousAbsentValue 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    fromValue - the lower bound (inclusive)
    
    返回:
    
    the smallest absent value larger than or equal to the specified value.
  - first
```
public int first()
```
    Get the first (smallest) integer in this RoaringBitmap, that is, returns the minimum of the set.
    
    指定者:
    
    first 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    the first (smallest) integer
    
    抛出:
    
    java.util.NoSuchElementException - if empty
  - last
```
public int last()
```
    Get the last (largest) integer in this RoaringBitmap, that is, returns the maximum of the set.
    
    指定者:
    
    last 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    the last (largest) integer
    
    抛出:
    
    java.util.NoSuchElementException - if empty
  - serialize
```
public void serialize(java.io.DataOutput out)
               throws java.io.IOException
```
    Serialize this bitmap. See format specification at https://github.com/RoaringBitmap/RoaringFormatSpec Consider calling runOptimize() before serialization to improve compression. The current bitmap is not modified. There is a distinct and dedicated method to serialize to a ByteBuffer. Note: Java's data structures are in big endian format. Roaring serializes to a little endian format, so the bytes are flipped by the library during serialization to ensure that what is stored is in little endian---despite Java's big endianness. You can defeat this process by reflipping the bytes again in a custom DataOutput which could lead to serialized Roaring objects with an incorrect byte order.
    
    指定者:
    
    serialize 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    out - the DataOutput stream
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - serialize
```
public void serialize(java.nio.ByteBuffer buffer)
```
    从接口复制的说明: ImmutableBitmapDataProvider
    Serialize this bitmap to a ByteBuffer. This is the preferred method to serialize to a byte array (byte[]) or to a String (via Base64.getEncoder().encodeToString).. Irrespective of the endianess of the provided buffer, data is written using LITTlE_ENDIAN as per the RoaringBitmap specification. The current bitmap is not modified.
```
 
   byte[] array = new byte[mrb.serializedSizeInBytes()];
   mrb.serialize(ByteBuffer.wrap(array));
 
 
```
    指定者:
    
    serialize 在接口中 ImmutableBitmapDataProvider
    
    参数:
    
    buffer - the ByteBuffer
  - maximumSerializedSize
```
public static long maximumSerializedSize(long cardinality,
                                         long universe_size)
```
    Assume that one wants to store "cardinality" integers in [0, universe_size), this function returns an upper bound on the serialized size in bytes.
    
    参数:
    
    cardinality - maximal cardinality
    
    universe_size - maximal value
    
    返回:
    
    upper bound on the serialized size in bytes of the bitmap
  - serializedSizeInBytes
```
public int serializedSizeInBytes()
```
    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 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    the size in bytes
  - toArray
```
public int[] toArray()
```
    Return the set values as an array, if the cardinality is smaller than 2147483648. The integer values are in sorted order.
    
    指定者:
    
    toArray 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    array representing the set values.
  - append
```
public void append(char key,
                   Container container)
```
    从接口复制的说明: 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
    
    container - the data to append
  - toMutableRoaringBitmap
```
public MutableRoaringBitmap toMutableRoaringBitmap()
```
    Convert (copies) to a mutable roaring bitmap.
    
    返回:
    
    a copy of this bitmap as a MutableRoaringBitmap
  - toString
```
public java.lang.String toString()
```
    A string describing the bitmap.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    the string
  - trim
```
public void trim()
```
    Recover allocated but unused memory.
    
    指定者:
    
    trim 在接口中 BitmapDataProvider
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    指定者:
    
    writeExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
  - xor
```
public void xor(RoaringBitmap x2)
```
    In-place bitwise XOR (symmetric difference) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - xor
```
public static RoaringBitmap xor(java.util.Iterator<? extends RoaringBitmap> bitmaps,
                                long rangeStart,
                                long rangeEnd)
```
    Computes XOR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    参数:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new result bitmap
  - xor
```
@Deprecated
public static RoaringBitmap xor(java.util.Iterator<? extends RoaringBitmap> bitmaps,
                                            int rangeStart,
                                            int rangeEnd)
```
    已过时。 use the version where longs specify the range. Negative values not allowed for rangeStart and rangeEnd
    
    Computes XOR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    参数:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    new result bi

类 RoaringBitmap

嵌套类概要

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

字段概要

构造器概要

方法概要

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

从接口继承的方法 java.lang.Iterable

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

字段详细资料

highLowContainer

构造器详细资料

RoaringBitmap

RoaringBitmap

RoaringBitmap

方法详细资料

addOffset

add

add

and

andCardinality

andNot

add

addN

bitmapOf

bitmapOfUnordered

bitmapOfRange

flip

flip

intersects

lazyor

lazyorfromlazyinputs

or

or

or

orCardinality

xorCardinality

andNotCardinality

remove

remove

xor

add

add

add

intersects

and

and

and

andNot

andNot

andNot

orNot

orNot

checkedAdd

checkedRemove

clear

clone

contains

contains

deserialize

deserialize

deserialize

equals

isHammingSimilar

flip

flip

flip

getLongCardinality

getCardinality

cardinalityExceeds

forEach

forAllInRange

forEachInRange

getContainerPointer

getIntIterator

getReverseIntIterator

getBatchIterator

getLongSizeInBytes

getSizeInBytes

hashCode