ImmutableBitmapDataProvider (RoaringBitmap 0.4.8 API)

All Known Subinterfaces:

BitmapDataProvider

All Known Implementing Classes:

ImmutableRoaringBitmap, MutableRoaringBitmap, RoaringBitmap
```
public interface ImmutableBitmapDataProvider
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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).
`int`	`getCardinality()` Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
`IntIterator`	`getIntIterator()`
`IntIterator`	`getReverseIntIterator()`
`int`	`getSizeInBytes()` Estimate of the memory usage of this data structure.
`boolean`	`isEmpty()` Checks whether the bitmap is empty.
`ImmutableBitmapDataProvider`	`limit(int x)` Create a new bitmap of the same class, containing at most maxcardinality integers.
`int`	`rank(int x)` Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()).
`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.

- Method Detail
  - getIntIterator
```
IntIterator getIntIterator()
```
    Returns:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - serializedSizeInBytes
```
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.
    
    Returns:
    
    the size in bytes
  - serialize
```
void serialize(DataOutput out)
        throws IOException
```
    Serialize this bitmap. The current bitmap is not modified.
    
    Parameters:
    
    out - the DataOutput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - contains
```
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).
    
    Parameters:
    
    x - integer value
    
    Returns:
    
    whether the integer value is included.
  - getCardinality
```
int getCardinality()
```
    Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
    
    Returns:
    
    the cardinality
  - getReverseIntIterator
```
IntIterator getReverseIntIterator()
```
    Returns:
    
    a custom iterator over set bits, the bits are traversed in descending sorted order
  - getSizeInBytes
```
int getSizeInBytes()
```
    Estimate of the memory usage of this data structure.
    
    Returns:
    
    estimated memory usage.
  - isEmpty
```
boolean isEmpty()
```
    Checks whether the bitmap is empty.
    
    Returns:
    
    true if this bitmap contains no set bit
  - toArray
```
int[] toArray()
```
    Return the set values as an array. The integer values are in sorted order.
    
    Returns:
    
    array representing the set values.
  - rank
```
int rank(int x)
```
    Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()).
    
    Parameters:
    
    x - upper limit
    
    Returns:
    
    the rank
  - limit
```
ImmutableBitmapDataProvider limit(int x)
```
    Create a new bitmap of the same class, containing at most maxcardinality integers.
    
    Parameters:
    
    x - maximal cardinality
    
    Returns:
    
    a new bitmap with cardinality no more than maxcardinality

Interface ImmutableBitmapDataProvider

Method Summary

Method Detail

getIntIterator

serializedSizeInBytes

serialize

contains

getCardinality

getReverseIntIterator

getSizeInBytes

isEmpty

toArray

rank

limit