MutableRoaringBitmap (RoaringBitmap 0.9.27-bitlap API)

java.lang.Object
- org.bitlap.roaringbitmap.buffer.ImmutableRoaringBitmap
- - org.bitlap.roaringbitmap.buffer.MutableRoaringBitmap

所有已实现的接口:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Integer>, AppendableStorage<MappeableContainer>, BitmapDataProvider, ImmutableBitmapDataProvider
```
public class MutableRoaringBitmap
extends ImmutableRoaringBitmap
implements java.lang.Cloneable, java.io.Serializable, java.lang.Iterable<java.lang.Integer>, java.io.Externalizable, BitmapDataProvider, AppendableStorage<MappeableContainer>
```
MutableRoaringBitmap, a compressed alternative to the BitSet. It is similar to org.roaringbitmap.RoaringBitmap, but it differs in that it can interact with ImmutableRoaringBitmap objects in the sense that MutableRoaringBitmap is derived from MutableRoaringBitmap. A MutableRoaringBitmap is an instance of an ImmutableRoaringBitmap (where methods like "serialize" are implemented). That is, they both share the same core (immutable) methods, but a MutableRoaringBitmap adds methods that allow you to modify the object. This design allows us to use MutableRoaringBitmap as ImmutableRoaringBitmap instances when needed. MutableRoaringBitmap instances can be casted to an ImmutableRoaringBitmap instance in constant time which means that code written for ImmutableRoaringBitmap instances run at full speed (without copies) on MutableRoaringBitmap instances. A MutableRoaringBitmap can be used much like an org.roaringbitmap.RoaringBitmap instance, and they serialize to the same output. The RoaringBitmap instance will be faster since it does not carry the overhead of a ByteBuffer back-end, but the MutableRoaringBitmap can be used as an ImmutableRoaringBitmap instance. Thus, if you use ImmutableRoaringBitmap, you probably need to use MutableRoaringBitmap instances as well; if you do not use ImmutableRoaringBitmap, you probably want to use only RoaringBitmap instances.
```
 
      import org.roaringbitmap.buffer.*;

      //...

      MutableRoaringBitmap rr = MutableRoaringBitmap.bitmapOf(1,2,3,1000);
      MutableRoaringBitmap rr2 = new MutableRoaringBitmap();
      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.
另请参阅:

ImmutableRoaringBitmap, RoaringBitmap, 序列化表格

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

构造器概要

构造器
构造器和说明
`MutableRoaringBitmap()` Create an empty bitmap
`MutableRoaringBitmap(MutableRoaringArray highLowContainer)`
`MutableRoaringBitmap(RoaringBitmap rb)` Create a MutableRoaringBitmap from a RoaringBitmap.

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`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 MutableRoaringBitmap`	`add(MutableRoaringBitmap rb, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`static MutableRoaringBitmap`	`add(MutableRoaringBitmap 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 MutableRoaringBitmap`	`addOffset(ImmutableRoaringBitmap x, long offset)` Generate a copy of the provided bitmap, but with all its values incremented by offset.
`void`	`and(ImmutableRoaringBitmap array)` In-place bitwise AND (intersection) operation.
`static MutableRoaringBitmap`	`and(MutableRoaringBitmap x1, MutableRoaringBitmap x2)` Bitwise AND (intersection) operation.
`void`	`andNot(ImmutableRoaringBitmap x2)` In-place bitwise ANDNOT (difference) operation.
`static MutableRoaringBitmap`	`andNot(MutableRoaringBitmap x1, MutableRoaringBitmap x2)` Bitwise ANDNOT (difference) operation.
`void`	`append(char key, MappeableContainer container)` Appends the key and container to the storage, throws if the key is less than the current mark.
`static MutableRoaringBitmap`	`bitmapOf(int... dat)` Generate a bitmap with the specified values set to true.
`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.
`MutableRoaringBitmap`	`clone()`
`void`	`deserialize(java.nio.ByteBuffer buffer)` Deserialize (retrieve) this bitmap.
`void`	`deserialize(java.io.DataInput in)` Deserialize the bitmap (retrieve from the input stream).
`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 MutableRoaringBitmap`	`flip(MutableRoaringBitmap rb, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`static MutableRoaringBitmap`	`flip(MutableRoaringBitmap bm, long rangeStart, long rangeEnd)` Complements the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive).
`MutableRoaringArray`	`getMappeableRoaringArray()`
`java.util.Iterator<java.lang.Integer>`	`iterator()` iterate over the positions of the true values.
`protected void`	`lazyor(ImmutableRoaringBitmap x2)`
`protected static MutableRoaringBitmap`	`lazyorfromlazyinputs(MutableRoaringBitmap x1, MutableRoaringBitmap x2)`
`static long`	`maximumSerializedSize(int cardinality, int 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(ImmutableRoaringBitmap x2)`
`static MutableRoaringBitmap`	`or(ImmutableRoaringBitmap... bitmaps)` Compute overall OR between bitmaps.
`void`	`or(ImmutableRoaringBitmap x2)` In-place bitwise OR (union) operation.
`static MutableRoaringBitmap`	`or(MutableRoaringBitmap x1, MutableRoaringBitmap x2)` Bitwise OR (union) operation.
`void`	`orNot(ImmutableRoaringBitmap other, long rangeEnd)` In-place bitwise ORNOT operation.
`protected static void`	`rangeSanityCheck(long rangeStart, long rangeEnd)`
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`remove(int x)` If present remove the specified integers (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 MutableRoaringBitmap`	`remove(MutableRoaringBitmap rb, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`static MutableRoaringBitmap`	`remove(MutableRoaringBitmap 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 estimated as more space efficient
`ImmutableRoaringBitmap`	`toImmutableRoaringBitmap()` Convenience method, effectively casts the object to an object of class ImmutableRoaringBitmap.
`void`	`trim()` Recover allocated but unused memory.
`void`	`writeExternal(java.io.ObjectOutput out)`
`void`	`xor(ImmutableRoaringBitmap x2)` In-place bitwise XOR (symmetric difference) operation.
`static MutableRoaringBitmap`	`xor(MutableRoaringBitmap x1, MutableRoaringBitmap x2)` Bitwise XOR (symmetric difference) operation.

从类继承的方法 org.bitlap.roaringbitmap.buffer.ImmutableRoaringBitmap
and, and, and, andCardinality, andNot, andNot, andNot, andNotCardinality, cardinalityExceeds, contains, contains, contains, equals, first, flip, flip, forEach, getBatchIterator, getCardinality, getContainerPointer, getIntIterator, getLongCardinality, getLongSizeInBytes, getReverseIntIterator, getSizeInBytes, hashCode, hasRunCompression, intersects, intersects, isEmpty, isHammingSimilar, last, lazyor, limit, nextAbsentValue, nextValue, or, or, or, or, orCardinality, orNot, previousAbsentValue, previousValue, rangeCardinality, rank, rankLong, select, serialize, serialize, serializedSizeInBytes, toArray, toMutableRoaringBitmap, toRoaringBitmap, toString, xor, xor, xor, xorCardinality

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

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

从接口继承的方法 org.bitlap.roaringbitmap.ImmutableBitmapDataProvider
contains, first, forEach, getBatchIterator, getCardinality, getIntIterator, getLongCardinality, getLongSizeInBytes, getReverseIntIterator, getSizeInBytes, isEmpty, last, limit, nextAbsentValue, nextValue, previousAbsentValue, previousValue, rangeCardinality, rank, rankLong, reverseStream, select, serialize, serialize, serializedSizeInBytes, stream, toArray

- 构造器详细资料
  - MutableRoaringBitmap
```
public MutableRoaringBitmap()
```
    Create an empty bitmap
  - MutableRoaringBitmap
```
public MutableRoaringBitmap(MutableRoaringArray highLowContainer)
```
  - MutableRoaringBitmap
```
public MutableRoaringBitmap(RoaringBitmap rb)
```
    Create a MutableRoaringBitmap from a RoaringBitmap. The RoaringBitmap is not modified.
    
    参数:
    
    rb - the original bitmap
- 方法详细资料
  - addOffset
```
public static MutableRoaringBitmap addOffset(ImmutableRoaringBitmap 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 (can be negative)
    
    返回:
    
    a new bitmap
  - add
```
public static MutableRoaringBitmap add(MutableRoaringBitmap 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 MutableRoaringBitmap add(MutableRoaringBitmap 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 MutableRoaringBitmap and(MutableRoaringBitmap x1,
                                       MutableRoaringBitmap x2)
```
    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
    
    返回:
    
    result of the operation
  - andNot
```
public static MutableRoaringBitmap andNot(MutableRoaringBitmap x1,
                                          MutableRoaringBitmap 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 MutableRoaringBitmap 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
  - rangeSanityCheck
```
protected static void rangeSanityCheck(long rangeStart,
                                       long rangeEnd)
```
  - flip
```
public static MutableRoaringBitmap flip(MutableRoaringBitmap 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
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    a new Bitmap
  - flip
```
@Deprecated
public static MutableRoaringBitmap flip(MutableRoaringBitmap 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
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    a new Bitmap
  - lazyorfromlazyinputs
```
protected static MutableRoaringBitmap lazyorfromlazyinputs(MutableRoaringBitmap x1,
                                                           MutableRoaringBitmap x2)
```
  - or
```
public static MutableRoaringBitmap or(ImmutableRoaringBitmap... bitmaps)
```
    Compute overall OR between bitmaps. (Effectively calls BufferFastAggregation.or(org.bitlap.roaringbitmap.buffer.ImmutableRoaringBitmap...))
    
    参数:
    
    bitmaps - input bitmaps
    
    返回:
    
    aggregated bitmap
  - or
```
public static MutableRoaringBitmap or(MutableRoaringBitmap x1,
                                      MutableRoaringBitmap x2)
```
    Bitwise OR (union) 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
  - remove
```
public static MutableRoaringBitmap remove(MutableRoaringBitmap 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 MutableRoaringBitmap remove(MutableRoaringBitmap 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 MutableRoaringBitmap xor(MutableRoaringBitmap x1,
                                       MutableRoaringBitmap 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.
    
    参数:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    返回:
    
    result of the operation
  - 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
  - and
```
public void and(ImmutableRoaringBitmap array)
```
    In-place bitwise AND (intersection) operation. The current bitmap is modified.
    
    参数:
    
    array - other bitmap
  - andNot
```
public void andNot(ImmutableRoaringBitmap x2)
```
    In-place bitwise ANDNOT (difference) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - orNot
```
public void orNot(ImmutableRoaringBitmap other,
                  long rangeEnd)
```
    In-place bitwise ORNOT operation. The current bitmap is modified.
    
    参数:
    
    other - the other bitmap
    
    rangeEnd - end point of the range (exclusive).
  - 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 MutableRoaringBitmap clone()
```
    覆盖:
    
    clone 在类中 ImmutableRoaringBitmap
  - deserialize
```
public void deserialize(java.io.DataInput in)
                 throws java.io.IOException
```
    Deserialize the bitmap (retrieve from the input stream). The current bitmap is overwritten. See format specification at https://github.com/RoaringBitmap/RoaringFormatSpec
    
    参数:
    
    in - the DataInput stream
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - deserialize
```
public void deserialize(java.nio.ByteBuffer buffer)
                 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.
    
    参数:
    
    buffer - the byte buffer (can be mapped, direct, array backed etc.
    
    抛出:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - 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
  - getMappeableRoaringArray
```
public MutableRoaringArray getMappeableRoaringArray()
```
    返回:
    
    a mutable copy of this bitmap
  - iterator
```
public java.util.Iterator<java.lang.Integer> iterator()
```
    iterate over the positions of the true values.
    
    指定者:
    
    iterator 在接口中 java.lang.Iterable<java.lang.Integer>
    
    覆盖:
    
    iterator 在类中 ImmutableRoaringBitmap
    
    返回:
    
    the iterator
  - lazyor
```
protected void lazyor(ImmutableRoaringBitmap x2)
```
  - naivelazyor
```
protected void naivelazyor(ImmutableRoaringBitmap x2)
```
  - or
```
public void or(ImmutableRoaringBitmap x2)
```
    In-place bitwise OR (union) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    指定者:
    
    readExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - remove
```
public void remove(int x)
```
    If present remove the specified integers (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 estimated as more space efficient
    
    返回:
    
    whether a change was applied
  - toImmutableRoaringBitmap
```
public ImmutableRoaringBitmap toImmutableRoaringBitmap()
```
    Convenience method, effectively casts the object to an object of class ImmutableRoaringBitmap. This function is equivalent to :
```
 
       (ImmutableRoaringBitmap) bitmap
 
 
```
    Some users would prefer to generate a hard copy of the data. The following code illustrates how to proceed, but note that the resulting copy can be expected to perform significantly worse than the original: the toImmutableRoaringBitmap method is almost free, it uses less memory and it produces a much faster bitmap.
```
 
      /////////////
      // Code to create a hard copy of MutableRoaringBitmap to an
      // ImmutableRoaringBitmap.
      // Usage of this code is discouraged because it is expensive
      // and it creates a copy that
      // suffers from more performance overhead than the original.
      /////////////
      import org.roaringbitmap.buffer.*;

      //...

      MutableRoaringBitmap rr = ... // some bitmap
      rr.runOptimize(); // can help compression

      // we are going to create an immutable copy of rr
      ByteBuffer outbb = ByteBuffer.allocate(mrb.serializedSizeInBytes());
      mrb.serialize(outbb);
      outbb.flip();
      ImmutableRoaringBitmap irb = new ImmutableRoaringBitmap(outbb);
 
 
```
    返回:
    
    a cast of this object
  - 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(ImmutableRoaringBitmap x2)
```
    In-place bitwise XOR (symmetric difference) operation. The current bitmap is modified.
    
    参数:
    
    x2 - other bitmap
  - maximumSerializedSize
```
public static long maximumSerializedSize(int cardinality,
                                         int 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. This function is identical to RoaringBitmap.maximumSerializedSize.
    
    参数:
    
    cardinality - maximal cardinality
    
    universe_size - maximal value
    
    返回:
    
    upper bound on the serialized size in bytes of the bitmap
  - append
```
public void append(char key,
                   MappeableContainer container)
```
    从接口复制的说明: AppendableStorage
    
    Appends the key and container to the storage, throws if the key is less than the current mark.
    
    指定者:
    
    append 在接口中 AppendableStorage<MappeableContainer>
    
    参数:
    
    key - the key to append
    
    container - the data to append

类 MutableRoaringBitmap

嵌套类概要

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

构造器概要

方法概要

从类继承的方法 org.bitlap.roaringbitmap.buffer.ImmutableRoaringBitmap

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

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

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

构造器详细资料

MutableRoaringBitmap

MutableRoaringBitmap

MutableRoaringBitmap

方法详细资料

addOffset

add

add

and

andNot

add

addN

bitmapOf

rangeSanityCheck

flip

flip

lazyorfromlazyinputs

or

or

remove

remove

xor

add

add

add

and

andNot

orNot

checkedAdd

checkedRemove

clear

clone

deserialize

deserialize

flip

flip

flip

getMappeableRoaringArray

iterator

lazyor

naivelazyor

or

readExternal

remove

remove

remove

removeRunCompression

repairAfterLazy

runOptimize

toImmutableRoaringBitmap

trim

writeExternal

xor

maximumSerializedSize

append