RoaringBitmap (RoaringBitmap 0.7.0 API)

java.lang.Object
- org.roaringbitmap.RoaringBitmap

All Implemented Interfaces:: Externalizable, Serializable, Cloneable, Iterable<Integer>, BitmapDataProvider, ImmutableBitmapDataProvider

Direct Known Subclasses:: FastRankRoaringBitmap

public class RoaringBitmap
extends Object
implements Cloneable, Serializable, Iterable<Integer>, Externalizable, ImmutableBitmapDataProvider, BitmapDataProvider

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.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description
`RoaringBitmap()` Create an empty bitmap
`RoaringBitmap(ImmutableRoaringBitmap rb)` Create a RoaringBitmap from a MutableRoaringBitmap or ImmutableRoaringBitmap.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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)` Deprecated. 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)` Deprecated. 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.
`static RoaringBitmap`	`and(Iterator bitmaps, int rangeStart, int rangeEnd)` Deprecated. use the version where longs specify the range. Negative range end are illegal.
`static RoaringBitmap`	`and(Iterator 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)` Deprecated. 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.
`static RoaringBitmap`	`bitmapOf(int... dat)` Generate a bitmap with the specified values set to true.
`static RoaringBitmap`	`bitmapOfUnordered(int... data)` Efficiently builds a RoaringBitmap from unordered data
`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 in included, which is equivalent to checking if the corresponding bit is set (get in BitSet class).
`boolean`	`contains(RoaringBitmap subset)` Checks whether the parameter is a subset of this RoaringBitmap or not
`void`	`deserialize(DataInput in)` Deserialize (retrieve) this bitmap.
`boolean`	`equals(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)` Deprecated. 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)` Deprecated. 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`	`forEach(IntConsumer ic)` Visit all values in the bitmap and pass them to the consumer.
`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()`
`boolean`	`hasRunCompression()` Check whether this bitmap has had its runs compressed.
`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.
`Iterator<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)`
`static RoaringBitmap`	`or(Iterator<? extends RoaringBitmap> bitmaps)` Compute overall OR between bitmaps.
`static RoaringBitmap`	`or(Iterator bitmaps, int rangeStart, int rangeEnd)` Deprecated. use the version where longs specify the range. Negative range points are forbidden.
`static RoaringBitmap`	`or(Iterator 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.
`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(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)` Deprecated. 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)` Deprecated. 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(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.
`String`	`toString()` A string describing the bitmap.
`void`	`trim()` Recover allocated but unused memory.
`void`	`writeExternal(ObjectOutput out)`
`static RoaringBitmap`	`xor(Iterator bitmaps, int rangeStart, int rangeEnd)` Deprecated. use the version where longs specify the range. Negative values not allowed for rangeStart and rangeEnd
`static RoaringBitmap`	`xor(Iterator 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.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - RoaringBitmap
```
public RoaringBitmap()
```
    Create an empty bitmap
  - RoaringBitmap
```
public RoaringBitmap(ImmutableRoaringBitmap rb)
```
    Create a RoaringBitmap from a MutableRoaringBitmap or ImmutableRoaringBitmap. The source is not modified.
    
    Parameters:
    
    rb - the original bitmap
- Method Detail
  - add
```
public static RoaringBitmap add(RoaringBitmap rb,
                                long rangeStart,
                                long rangeEnd)
```
    Generate a new bitmap with all integers in [rangeStart,rangeEnd) added.
    
    Parameters:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    new bitmap
  - add
```
@Deprecated
public static RoaringBitmap add(RoaringBitmap rb,
                                            int rangeStart,
                                            int rangeEnd)
```
    Deprecated. use the version where longs specify the range
    
    Generate a new bitmap with all integers in [rangeStart,rangeEnd) added.
    
    Parameters:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    result of the operation
    
    See Also:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    as if you did and(x2,x2).getCardinality()
    
    See Also:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    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.
    
    Parameters:
    
    dat - set values
  - 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.
    
    Parameters:
    
    dat - set values
    
    Returns:
    
    a new bitmap
  - bitmapOfUnordered
```
public static RoaringBitmap bitmapOfUnordered(int... data)
```
    Efficiently builds a RoaringBitmap from unordered data
    
    Parameters:
    
    data - unsorted data
    
    Returns:
    
    a new bitmap
  - 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.
    
    Parameters:
    
    bm - bitmap being negated
    
    rangeStart - inclusive beginning of range, in [0, 0xffffffff]
    
    rangeEnd - exclusive ending of range, in [0, 0xffffffff + 1]
    
    Returns:
    
    a new Bitmap
  - flip
```
@Deprecated
public static RoaringBitmap flip(RoaringBitmap rb,
                                             int rangeStart,
                                             int rangeEnd)
```
    Deprecated. 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.
    
    Parameters:
    
    rb - bitmap being negated
    
    rangeStart - inclusive beginning of range, in [0, 0xffffffff]
    
    rangeEnd - exclusive ending of range, in [0, 0xffffffff + 1]
    
    Returns:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    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(Iterator<? extends RoaringBitmap> bitmaps)
```
    Compute overall OR between bitmaps. (Effectively calls FastAggregation.or(java.util.Iterator<? extends org.roaringbitmap.RoaringBitmap>))
    
    Parameters:
    
    bitmaps - input bitmaps
    
    Returns:
    
    aggregated bitmap
  - or
```
public static RoaringBitmap or(RoaringBitmap... bitmaps)
```
    Compute overall OR between bitmaps. (Effectively calls FastAggregation.or(java.util.Iterator<? extends org.roaringbitmap.RoaringBitmap>))
    
    Parameters:
    
    bitmaps - input bitmaps
    
    Returns:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    result of the operation
    
    See Also:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    cardinality of the union
    
    See Also:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    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.
    
    Parameters:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    new bitmap
  - remove
```
@Deprecated
public static RoaringBitmap remove(RoaringBitmap rb,
                                               int rangeStart,
                                               int rangeEnd)
```
    Deprecated. use the version where longs specify the range
    
    Generate a new bitmap with all integers in [rangeStart,rangeEnd) removed.
    
    Parameters:
    
    rb - initial bitmap (will not be modified)
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    Returns:
    
    result of the operation
    
    See Also:
    
    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. Javac 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.
    
    Specified by:
    
    add in interface BitmapDataProvider
    
    Parameters:
    
    x - integer value
  - add
```
public void add(long rangeStart,
                long rangeEnd)
```
    Add to the current bitmap all integers in [rangeStart,rangeEnd).
    
    Parameters:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - add
```
@Deprecated
public void add(int rangeStart,
                            int rangeEnd)
```
    Deprecated. use the version where longs specify the range
    
    Add to the current bitmap all integers in [rangeStart,rangeEnd).
    
    Parameters:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - and
```
public void and(RoaringBitmap x2)
```
    In-place bitwise AND (intersection) operation. The current bitmap is modified.
    
    Parameters:
    
    x2 - other bitmap
  - and
```
public static RoaringBitmap and(Iterator bitmaps,
                                long rangeStart,
                                long rangeEnd)
```
    Computes AND between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    Parameters:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    new result bitmap
  - and
```
@Deprecated
public static RoaringBitmap and(Iterator bitmaps,
                                            int rangeStart,
                                            int rangeEnd)
```
    Deprecated. 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)
    
    Parameters:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    new result bitmap
  - andNot
```
public void andNot(RoaringBitmap x2)
```
    In-place bitwise ANDNOT (difference) operation. The current bitmap is modified.
    
    Parameters:
    
    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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    rangeStart - starting point of the range (inclusive)
    
    rangeEnd - end point of the range (exclusive)
    
    Returns:
    
    result of the operation
  - andNot
```
@Deprecated
public static RoaringBitmap andNot(RoaringBitmap x1,
                                               RoaringBitmap x2,
                                               int rangeStart,
                                               int rangeEnd)
```
    Deprecated. 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.
    
    Parameters:
    
    x1 - first bitmap
    
    x2 - other bitmap
    
    rangeStart - starting point of the range (inclusive)
    
    rangeEnd - end point of the range (exclusive)
    
    Returns:
    
    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.
    
    Parameters:
    
    x - integer value
    
    Returns:
    
    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)
    
    Parameters:
    
    x - integer value representing the index in a bitmap
    
    Returns:
    
    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()
```
    Overrides:
    
    clone in class 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).
    
    Specified by:
    
    contains in interface ImmutableBitmapDataProvider
    
    Parameters:
    
    x - integer value
    
    Returns:
    
    whether the integer value is included.
  - deserialize
```
public void deserialize(DataInput in)
                 throws IOException
```
    Deserialize (retrieve) this bitmap. See format specification at https://github.com/RoaringBitmap/RoaringFormatSpec The current bitmap is overwritten.
    
    Parameters:
    
    in - the DataInput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class 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.
    
    Parameters:
    
    other - the bitmap to compare to
    
    tolerance - the maximum number of bits that may differ
    
    Returns:
    
    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.
    
    Parameters:
    
    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).
    
    Parameters:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - flip
```
@Deprecated
public void flip(int rangeStart,
                             int rangeEnd)
```
    Deprecated. 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).
    
    Parameters:
    
    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).
    
    Specified by:
    
    getLongCardinality in interface ImmutableBitmapDataProvider
    
    Returns:
    
    the cardinality
  - getCardinality
```
public int getCardinality()
```
    Description copied from interface: 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.
    
    Specified by:
    
    getCardinality in interface ImmutableBitmapDataProvider
    
    Returns:
    
    the cardinality
  - forEach
```
public void forEach(IntConsumer ic)
```
    Description copied from interface: 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
      
    }});
   
 }
 
```
    Specified by:
    
    forEach in interface ImmutableBitmapDataProvider
    
    Parameters:
    
    ic - the consumer
  - getContainerPointer
```
public ContainerPointer getContainerPointer()
```
    Return a low-level container pointer that can be used to access the underlying data structure.
    
    Returns:
    
    container pointer
  - getIntIterator
```
public PeekableIntIterator getIntIterator()
```
    For better performance, consider the Use the forEach method.
    
    Specified by:
    
    getIntIterator in interface ImmutableBitmapDataProvider
    
    Returns:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - getReverseIntIterator
```
public IntIterator getReverseIntIterator()
```
    Specified by:
    
    getReverseIntIterator in interface ImmutableBitmapDataProvider
    
    Returns:
    
    a custom iterator over set bits, the bits are traversed in descending sorted order
  - 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.
    
    Specified by:
    
    getLongSizeInBytes in interface ImmutableBitmapDataProvider
    
    Returns:
    
    estimated memory usage.
  - getSizeInBytes
```
public int getSizeInBytes()
```
    Description copied from interface: ImmutableBitmapDataProvider
    
    Estimate of the memory usage of this data structure. Internally, this is computed as a 64-bit counter.
    
    Specified by:
    
    getSizeInBytes in interface ImmutableBitmapDataProvider
    
    Returns:
    
    estimated memory usage.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hasRunCompression
```
public boolean hasRunCompression()
```
    Check whether this bitmap has had its runs compressed.
    
    Returns:
    
    whether this bitmap has run compression
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether the bitmap is empty.
    
    Specified by:
    
    isEmpty in interface ImmutableBitmapDataProvider
    
    Returns:
    
    true if this bitmap contains no set bit
  - iterator
```
public Iterator<Integer> iterator()
```
    iterate over the positions of the true values.
    
    Specified by:
    
    iterator in interface Iterable<Integer>
    
    Returns:
    
    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.
    
    Specified by:
    
    limit in interface ImmutableBitmapDataProvider
    
    Parameters:
    
    maxcardinality - maximal cardinality
    
    Returns:
    
    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.
    
    Parameters:
    
    x2 - other bitmap
  - or
```
public static RoaringBitmap or(Iterator bitmaps,
                               long rangeStart,
                               long rangeEnd)
```
    Computes OR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    Parameters:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    new result bitmap
  - or
```
@Deprecated
public static RoaringBitmap or(Iterator bitmaps,
                                           int rangeStart,
                                           int rangeEnd)
```
    Deprecated. 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)
    
    Parameters:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    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()).
    
    Specified by:
    
    rankLong in interface ImmutableBitmapDataProvider
    
    Parameters:
    
    x - upper limit
    
    Returns:
    
    the rank
    
    See Also:
    
    Ranking in statistics
  - rank
```
public int rank(int x)
```
    Description copied from interface: ImmutableBitmapDataProvider
    
    Rank returns the number of integers that are smaller or equal to x (rank(infinity) would be getCardinality()). The value is internally computed as a 64-bit number.
    
    Specified by:
    
    rank in interface ImmutableBitmapDataProvider
    
    Parameters:
    
    x - upper limit
    
    Returns:
    
    the rank
    
    See Also:
    
    Ranking in statistics
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - remove
```
public void remove(int x)
```
    If present remove the specified integer (effectively, sets its bit value to false)
    
    Specified by:
    
    remove in interface BitmapDataProvider
    
    Parameters:
    
    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).
    
    Parameters:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - remove
```
@Deprecated
public void remove(int rangeStart,
                               int rangeEnd)
```
    Deprecated. use the version where longs specify the range
    
    Remove from the current bitmap all integers in [rangeStart,rangeEnd).
    
    Parameters:
    
    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
    
    Returns:
    
    whether a change was applied
  - repairAfterLazy
```
protected void repairAfterLazy()
```
  - runOptimize
```
public boolean runOptimize()
```
    Use a run-length encoding where it is more space efficient
    
    Returns:
    
    whether a change was applied
  - contains
```
public boolean contains(RoaringBitmap subset)
```
    Checks whether the parameter is a subset of this RoaringBitmap or not
    
    Parameters:
    
    subset - the potential subset
    
    Returns:
    
    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.
    
    Specified by:
    
    select in interface ImmutableBitmapDataProvider
    
    Parameters:
    
    j - index of the value
    
    Returns:
    
    the value
    
    See Also:
    
    Selection algorithm
  - first
```
public int first()
```
    Get the first (smallest) integer in this RoaringBitmap, that is, returns the minimum of the set.
    
    Specified by:
    
    first in interface ImmutableBitmapDataProvider
    
    Returns:
    
    the first (smallest) integer
    
    Throws:
    
    NoSuchElementException - if empty
  - last
```
public int last()
```
    Get the last (largest) integer in this RoaringBitmap, that is, returns the maximum of the set.
    
    Specified by:
    
    last in interface ImmutableBitmapDataProvider
    
    Returns:
    
    the last (largest) integer
    
    Throws:
    
    NoSuchElementException - if empty
  - serialize
```
public void serialize(DataOutput out)
               throws 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. Advanced example: To serialize your bitmap to a ByteBuffer, you can do the following.
```
 
   //r is your bitmap

   r.runOptimize(); // might improve compression
   // next we create the ByteBuffer where the data will be stored
   ByteBuffer outbb = ByteBuffer.allocate(r.serializedSizeInBytes());
   // then we can serialize on a custom OutputStream
   mrb.serialize(new DataOutputStream(new OutputStream(){
       ByteBuffer mBB;
       OutputStream init(ByteBuffer mbb) {mBB=mbb; return this;}
       public void close() {}
       public void flush() {}
       public void write(int b) {
         mBB.put((byte) b);}
       public void write(byte[] b) {mBB.put(b);}
       public void write(byte[] b, int off, int l) {mBB.put(b,off,l);}
   }.init(outbb)));
   // outbuff will now contain a serialized version of your bitmap
 
 
```
    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.
    Specified by:
    
    serialize in interface ImmutableBitmapDataProvider
    
    Parameters:
    
    out - the DataOutput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - 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.
    
    Parameters:
    
    cardinality - maximal cardinality
    
    universe_size - maximal value
    
    Returns:
    
    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.
    
    Specified by:
    
    serializedSizeInBytes in interface ImmutableBitmapDataProvider
    
    Returns:
    
    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.
    
    Specified by:
    
    toArray in interface ImmutableBitmapDataProvider
    
    Returns:
    
    array representing the set values.
  - toMutableRoaringBitmap
```
public MutableRoaringBitmap toMutableRoaringBitmap()
```
    Convert (copies) to a mutable roaring bitmap.
    
    Returns:
    
    a copy of this bitmap as a MutableRoaringBitmap
  - toString
```
public String toString()
```
    A string describing the bitmap.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string
  - trim
```
public void trim()
```
    Recover allocated but unused memory.
    
    Specified by:
    
    trim in interface BitmapDataProvider
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - xor
```
public void xor(RoaringBitmap x2)
```
    In-place bitwise XOR (symmetric difference) operation. The current bitmap is modified.
    
    Parameters:
    
    x2 - other bitmap
  - xor
```
public static RoaringBitmap xor(Iterator bitmaps,
                                long rangeStart,
                                long rangeEnd)
```
    Computes XOR between input bitmaps in the given range, from rangeStart (inclusive) to rangeEnd (exclusive)
    
    Parameters:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    new result bitmap
  - xor
```
@Deprecated
public static RoaringBitmap xor(Iterator bitmaps,
                                            int rangeStart,
                                            int rangeEnd)
```
    Deprecated. 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)
    
    Parameters:
    
    bitmaps - input bitmaps, these are not modified
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
    
    Returns:
    
    new result bi

Class RoaringBitmap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

RoaringBitmap

RoaringBitmap

Method Detail

add

add

and

andCardinality

andNot

add

bitmapOf

bitmapOfUnordered

flip

flip

intersects

lazyor

lazyorfromlazyinputs

or

or

or

orCardinality

xorCardinality

andNotCardinality

remove

remove

xor

add

add

add

and

and

and

andNot

andNot

andNot

checkedAdd

checkedRemove

clear

clone

contains

deserialize

equals

isHammingSimilar

flip

flip

flip

getLongCardinality

getCardinality

forEach

getContainerPointer

getIntIterator

getReverseIntIterator

getLongSizeInBytes

getSizeInBytes

hashCode

hasRunCompression

isEmpty

iterator

lazyor

naivelazyor

limit

or

or

or

rankLong

rank

readExternal

remove

remove

remove

removeRunCompression

repairAfterLazy

runOptimize

contains

select