ImmutableRoaringBitmap (RoaringBitmap 0.9.27-bitlap API)

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

所有已实现的接口:

java.lang.Cloneable, java.lang.Iterable<java.lang.Integer>, ImmutableBitmapDataProvider

直接已知子类:

MutableRoaringBitmap
```
public class ImmutableRoaringBitmap
extends java.lang.Object
implements java.lang.Iterable<java.lang.Integer>, java.lang.Cloneable, ImmutableBitmapDataProvider
```
ImmutableRoaringBitmap provides a compressed immutable (cannot be modified) bitmap. It is meant to be used with org.roaringbitmap.buffer.MutableRoaringBitmap, a derived class that adds methods to modify the bitmap. Because the class ImmutableRoaringBitmap is not final and because there exists one derived class (org.roaringbitmap.buffer.MutableRoaringBitmap), then it is possible for the programmer to modify some ImmutableRoaringBitmap instances, but this invariably involves casting to other classes: if your code is written in terms of ImmutableRoaringBitmap instances, then your objects will be truly immutable, and thus easy to reason about. Pure (non-derived) instances of ImmutableRoaringBitmap have their data backed by a ByteBuffer. This has the benefit that they may be constructed from a ByteBuffer (useful for memory mapping). Objects of this class may reside almost entirely in memory-map files. That is the primary reason for them to be considered immutable, since no reallocation is possible when using memory-mapped files. From a language design point of view, instances of this class are immutable only when used as per the interface of the ImmutableRoaringBitmap class. Given that the class is not final, it is possible to modify instances, through other interfaces. Thus we do not take the term "immutable" in a purist manner, but rather in a practical one. One of our motivations for this design where MutableRoaringBitmap instances can be casted down to ImmutableRoaringBitmap instances is that bitmaps are often large, or used in a context where memory allocations are to be avoided, so we avoid forcing copies. Copies could be expected if one needs to mix and match ImmutableRoaringBitmap and MutableRoaringBitmap instances.
```
 
       import org.roaringbitmap.buffer.*;

       //...

       MutableRoaringBitmap rr1 = MutableRoaringBitmap.bitmapOf(1, 2, 3, 1000);
       MutableRoaringBitmap rr2 = MutableRoaringBitmap.bitmapOf(2, 3, 1010);
       ByteArrayOutputStream bos = new ByteArrayOutputStream();
       DataOutputStream dos = new DataOutputStream(bos);
       // could call "rr1.runOptimize()" and "rr2.runOptimize" if
       // there were runs to compress
       rr1.serialize(dos);
       rr2.serialize(dos);
       dos.close();
       ByteBuffer bb = ByteBuffer.wrap(bos.toByteArray());
       ImmutableRoaringBitmap rrback1 = new ImmutableRoaringBitmap(bb);
       bb.position(bb.position() + rrback1.serializedSizeInBytes());
       ImmutableRoaringBitmap rrback2 = new ImmutableRoaringBitmap(bb);
 
 
```
另请参阅:

MutableRoaringBitmap

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

构造器概要

构造器
限定符	构造器和说明
`protected`	`ImmutableRoaringBitmap()`
	`ImmutableRoaringBitmap(java.nio.ByteBuffer b)` Constructs a new ImmutableRoaringBitmap starting at this ByteBuffer's position().

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`static MutableRoaringBitmap`	`and(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Bitwise AND (intersection) operation.
`static MutableRoaringBitmap`	`and(java.util.Iterator<? extends ImmutableRoaringBitmap> bitmaps, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative range end are illegal.
`static MutableRoaringBitmap`	`and(java.util.Iterator<? extends ImmutableRoaringBitmap> bitmaps, long rangeStart, long rangeEnd)` Computes AND between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
`static int`	`andCardinality(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Cardinality of Bitwise AND (intersection) operation.
`static MutableRoaringBitmap`	`andNot(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Bitwise ANDNOT (difference) operation.
`static MutableRoaringBitmap`	`andNot(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative values for range endpoints are not allowed.
`static MutableRoaringBitmap`	`andNot(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2, long rangeStart, long rangeEnd)` Bitwise ANDNOT (difference) operation for the given range, rangeStart (inclusive) and rangeEnd (exclusive).
`static int`	`andNotCardinality(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Cardinality of the bitwise ANDNOT (left difference) operation.
`static ImmutableRoaringBitmap`	`bitmapOf(int... data)` Generate a bitmap with the specified values set to true.
`boolean`	`cardinalityExceeds(long threshold)` Returns true if the bitmap's cardinality exceeds the threshold.
`ImmutableRoaringBitmap`	`clone()`
`boolean`	`contains(ImmutableRoaringBitmap subset)` Checks whether the parameter is a subset of this RoaringBitmap or not
`boolean`	`contains(int x)` Checks whether the value in 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`	`equals(java.lang.Object o)`
`int`	`first()` Get the first (smallest) integer in this RoaringBitmap, that is, returns the minimum of the set.
`static MutableRoaringBitmap`	`flip(ImmutableRoaringBitmap bm, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range
`static MutableRoaringBitmap`	`flip(ImmutableRoaringBitmap bm, long rangeStart, long rangeEnd)` Complements the bits in the given range, from rangeStart (inclusive) rangeEnd (exclusive).
`void`	`forEach(IntConsumer ic)` Visit all values in the bitmap and pass them to the consumer
`BatchIterator`	`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).
`MappeableContainerPointer`	`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.
`static boolean`	`intersects(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Checks whether the two bitmaps intersect.
`boolean`	`intersects(long minimum, long supremum)` Checks if the range intersects with the bitmap.
`boolean`	`isEmpty()` Checks whether the bitmap is empty.
`boolean`	`isHammingSimilar(ImmutableRoaringBitmap 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 static MutableRoaringBitmap`	`lazyor(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)`
`MutableRoaringBitmap`	`limit(int maxcardinality)` Create a new Roaring bitmap containing at most maxcardinality integers.
`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 MutableRoaringBitmap`	`or(ImmutableRoaringBitmap... bitmaps)` Compute overall OR between bitmaps.
`static MutableRoaringBitmap`	`or(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Bitwise OR (union) operation.
`static MutableRoaringBitmap`	`or(java.util.Iterator<? extends ImmutableRoaringBitmap> bitmaps)` Compute overall OR between bitmaps.
`static MutableRoaringBitmap`	`or(java.util.Iterator<? extends ImmutableRoaringBitmap> bitmaps, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative range points are forbidden.
`static MutableRoaringBitmap`	`or(java.util.Iterator<? extends ImmutableRoaringBitmap> bitmaps, long rangeStart, long rangeEnd)` Computes OR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
`static int`	`orCardinality(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Cardinality of the bitwise OR (union) operation.
`static MutableRoaringBitmap`	`orNot(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap 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()).
`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 for serialization.
`int[]`	`toArray()` Return the set values as an array if the cardinality is less than 2147483648.
`MutableRoaringBitmap`	`toMutableRoaringBitmap()` Copies the content of this bitmap to a bitmap that can be modified.
`RoaringBitmap`	`toRoaringBitmap()` Copies this bitmap to a mutable RoaringBitmap.
`java.lang.String`	`toString()` A string describing the bitmap.
`static MutableRoaringBitmap`	`xor(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap x2)` Bitwise XOR (symmetric difference) operation.
`static MutableRoaringBitmap`	`xor(java.util.Iterator<? extends ImmutableRoaringBitmap> bitmaps, int rangeStart, int rangeEnd)` 已过时。 use the version where longs specify the range. Negative values not allowed for rangeStart and rangeEnd
`static MutableRoaringBitmap`	`xor(java.util.Iterator<? extends ImmutableRoaringBitmap> bitmaps, long rangeStart, long rangeEnd)` Computes XOR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
`static int`	`xorCardinality(ImmutableRoaringBitmap x1, ImmutableRoaringBitmap 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

- 构造器详细资料
  - ImmutableRoaringBitmap
```
protected ImmutableRoaringBitmap()
```
  - ImmutableRoaringBitmap
```
public ImmutableRoaringBitmap(java.nio.ByteBuffer b)
```
    Constructs a new ImmutableRoaringBitmap starting at this ByteBuffer's position(). Only meta-data is loaded to RAM. The rest is mapped to the ByteBuffer. The byte stream should abide by the format specification https://github.com/RoaringBitmap/RoaringFormatSpec It is not necessary that limit() on the input ByteBuffer indicates the end of the serialized data. After creating this ImmutableRoaringBitmap, you can advance to the rest of the data (if there is more) by setting b.position(b.position() + bitmap.serializedSizeInBytes()); Note that the input ByteBuffer is effectively copied (with the slice operation) so you should expect the provided ByteBuffer position/mark/limit/order to remain unchanged. This constructor may throw IndexOutOfBoundsException if the input is invalid/corrupted. This constructor throws an InvalidRoaringFormat if the provided input does not have a valid cookie or suffers from similar problems.
    
    参数:
    
    b - data source
- 方法详细资料
  - and
```
public static MutableRoaringBitmap and(java.util.Iterator<? extends ImmutableRoaringBitmap> 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 MutableRoaringBitmap and(java.util.Iterator<? extends ImmutableRoaringBitmap> 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
  - and
```
public static MutableRoaringBitmap and(ImmutableRoaringBitmap x1,
                                       ImmutableRoaringBitmap 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
    
    另请参阅:
    
    BufferFastAggregation.and(ImmutableRoaringBitmap...)
  - andCardinality
```
public static int andCardinality(ImmutableRoaringBitmap x1,
                                 ImmutableRoaringBitmap 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()
    
    另请参阅:
    
    BufferFastAggregation.and(ImmutableRoaringBitmap...)
  - xorCardinality
```
public static int xorCardinality(ImmutableRoaringBitmap x1,
                                 ImmutableRoaringBitmap 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(ImmutableRoaringBitmap x1,
                                    ImmutableRoaringBitmap 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
  - andNot
```
public static MutableRoaringBitmap andNot(ImmutableRoaringBitmap x1,
                                          ImmutableRoaringBitmap 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 - beginning of the range (inclusive)
    
    rangeEnd - end of range (exclusive)
    
    返回:
    
    result of the operation
  - andNot
```
@Deprecated
public static MutableRoaringBitmap andNot(ImmutableRoaringBitmap x1,
                                                      ImmutableRoaringBitmap 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 - beginning of the range (inclusive)
    
    rangeEnd - end of range (exclusive)
    
    返回:
    
    result of the operation
  - andNot
```
public static MutableRoaringBitmap andNot(ImmutableRoaringBitmap x1,
                                          ImmutableRoaringBitmap 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
  - orNot
```
public static MutableRoaringBitmap orNot(ImmutableRoaringBitmap x1,
                                         ImmutableRoaringBitmap 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
  - bitmapOf
```
public static ImmutableRoaringBitmap bitmapOf(int... data)
```
    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. This function is equivalent to :
```
 
       (ImmutableRoaringBitmap) MutableRoaringBitmap.bitmapOf(data)
 
 
```
    参数:
    
    data - set values
    
    返回:
    
    a new bitmap
  - flip
```
public static MutableRoaringBitmap flip(ImmutableRoaringBitmap 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(ImmutableRoaringBitmap bm,
                                                    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.
    
    参数:
    
    bm - bitmap being negated
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    返回:
    
    a new Bitmap
  - intersects
```
public static boolean intersects(ImmutableRoaringBitmap x1,
                                 ImmutableRoaringBitmap 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 MutableRoaringBitmap lazyor(ImmutableRoaringBitmap x1,
                                             ImmutableRoaringBitmap 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(ImmutableRoaringBitmap x1,
                                      ImmutableRoaringBitmap 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
    
    另请参阅:
    
    BufferFastAggregation.or(ImmutableRoaringBitmap...), BufferFastAggregation.horizontal_or(ImmutableRoaringBitmap...)
  - or
```
public static MutableRoaringBitmap or(java.util.Iterator<? extends 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(java.util.Iterator<? extends ImmutableRoaringBitmap> 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 MutableRoaringBitmap or(java.util.Iterator<? extends ImmutableRoaringBitmap> 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
  - orCardinality
```
public static int orCardinality(ImmutableRoaringBitmap x1,
                                ImmutableRoaringBitmap 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
    
    另请参阅:
    
    BufferFastAggregation.or(ImmutableRoaringBitmap...), BufferFastAggregation.horizontal_or(ImmutableRoaringBitmap...)
  - xor
```
public static MutableRoaringBitmap xor(java.util.Iterator<? extends ImmutableRoaringBitmap> 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 MutableRoaringBitmap xor(java.util.Iterator<? extends ImmutableRoaringBitmap> 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 bitmap
  - xor
```
public static MutableRoaringBitmap xor(ImmutableRoaringBitmap x1,
                                       ImmutableRoaringBitmap 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
    
    另请参阅:
    
    BufferFastAggregation.xor(ImmutableRoaringBitmap...), BufferFastAggregation.horizontal_xor(ImmutableRoaringBitmap...)
  - clone
```
public ImmutableRoaringBitmap clone()
```
    覆盖:
    
    clone 在类中 java.lang.Object
  - contains
```
public boolean contains(int x)
```
    Checks whether the value in 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
  - contains
```
public boolean contains(ImmutableRoaringBitmap 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
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - isHammingSimilar
```
public boolean isHammingSimilar(ImmutableRoaringBitmap 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
  - 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
  - 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
  - getContainerPointer
```
public MappeableContainerPointer 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 BatchIterator 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. When the bitmap is constructed from a ByteBuffer from a memory-mapped file, this estimate is invalid: we can expect the actual memory usage to be significantly (e.g., 10x) less. 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. When the bitmap is constructed from a ByteBuffer from a memory-mapped file, this estimate is invalid: we can expect the actual memory usage to be significantly (e.g., 10x) less. 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
  - limit
```
public MutableRoaringBitmap 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
  - 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
  - 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
  - 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
  - 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.
  - 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 MutableRoaringBitmap.runOptimize() before serialization to improve compression if this is a MutableRoaringBitmap instance. 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
  - serializedSizeInBytes
```
public int serializedSizeInBytes()
```
    Report the number of bytes required for serialization. This count will match the bytes written when calling the serialize method.
    
    指定者:
    
    serializedSizeInBytes 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    the size in bytes
  - toArray
```
public int[] toArray()
```
    Return the set values as an array if the cardinality is less than 2147483648. The integer values are in sorted order.
    
    指定者:
    
    toArray 在接口中 ImmutableBitmapDataProvider
    
    返回:
    
    array representing the set values.
  - toMutableRoaringBitmap
```
public MutableRoaringBitmap toMutableRoaringBitmap()
```
    Copies the content of this bitmap to a bitmap that can be modified.
    
    返回:
    
    a mutable bitmap.
  - toRoaringBitmap
```
public RoaringBitmap toRoaringBitmap()
```
    Copies this bitmap to a mutable RoaringBitmap.
    
    返回:
    
    a copy of this bitmap as a RoaringBitmap.
  - toString
```
public java.lang.String toString()
```
    A string describing the bitmap.
    
    覆盖:
    
    toString 在类中 java.lang.Object
    
    返回:
    
    the string

类 ImmutableRoaringBitmap

嵌套类概要

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

构造器概要

方法概要

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

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

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

构造器详细资料

ImmutableRoaringBitmap

ImmutableRoaringBitmap

方法详细资料

and

and

and

andCardinality

xorCardinality

andNotCardinality

andNot

andNot

andNot

orNot

bitmapOf

flip

flip

intersects

lazyor

or

or

or

or

or

orCardinality

xor

xor

xor

clone

contains

contains

contains

equals

isHammingSimilar

intersects

getLongCardinality

getCardinality

cardinalityExceeds

forEach

getContainerPointer

getIntIterator

getReverseIntIterator

getBatchIterator

getLongSizeInBytes

getSizeInBytes

hashCode

hasRunCompression

isEmpty

iterator

limit

rankLong

rangeCardinality

rank

select

first

last

nextValue

previousValue

nextAbsentValue

previousAbsentValue

serialize

serialize

serializedSizeInBytes

toArray

toMutableRoaringBitmap

toRoaringBitmap

toString