Package org.roaringbitmap
The org.roaringbitmap package provides
one class (
RoaringBitmap
) that users
can rely upon for fast set of integers.
import org.roaringbitmap.*;
//...
RoaringBitmap r1 = new RoaringBitmap();
for(int k = 4000; k<4255;++k) r1.add(k);
RoaringBitmap r2 = new RoaringBitmap();
for(int k = 1000; k<4255; k+=2) r2.add(k);
RoaringBitmap union = RoaringBitmap.or(r1, r2);
RoaringBitmap intersection = RoaringBitmap.and(r1, r2);
//...
DataOutputStream wheretoserialize = ...
r1.runOptimize(); // can help compression
r1.serialize(wheretoserialize);
-
Interface Summary Interface Description AppendableStorage<T> Key-value storage of 16 bit containersBatchIterator BitmapDataProvider Representing a general bitmap interface.BitmapDataProviderSupplier Enable customizing theBitmapDataProvider
used byRoaring64NavigableMap
CharIterator Iterator over short values.ContainerBatchIterator ContainerPointer This interface allows you to iterate over the containers in a roaring bitmap.ImmutableBitmapDataProvider Interface representing an immutable bitmap.IntConsumer An IntConsumer receives the int values contained in a data structure.IntIterator A simple iterator over integer values.PeekableCharIterator Simple extension to the CharIterator interfacePeekableCharRankIterator PeekableCharIterator that calculates the next value rank during iterationPeekableIntIterator Simple extension to the IntIterator interface.PeekableIntRankIterator PeekableIntIterator that calculates the next value rank during iterationRelativeRangeConsumer A consumer interface to process ranges of value contained in a bitmap using relative offsets.RoaringBitmapWriter<T extends BitmapDataProvider> WordStorage<T> -
Class Summary Class Description ArrayBatchIterator ArrayContainer Simple container made of an array of 16-bit integersBatchIntIterator Wraps a batch iterator for use as an IntIteratorBitmapBatchIterator BitmapContainer Simple bitset-like container.BitSetUtil This class provides convenience functions to manipulate BitSet and RoaringBitmap objects.ConstantMemoryContainerAppender<T extends BitmapDataProvider & AppendableStorage<Container>> This class can be used to write quickly values to a bitmap.Container Base container class.ContainerAppender<C extends WordStorage<C>,T extends BitmapDataProvider & AppendableStorage<C>> This class can be used to write quickly values to a bitmap.FastAggregation Fast algorithms to aggregate many bitmaps.FastRankRoaringBitmap This extendsRoaringBitmap
to provide better performance for .rank and .select operations, at the cost of maintain a cache of cardinalities.ImmutableBitmapDataProvider.RoaringOfInt An internal class to help provide streams.IntConsumerRelativeRangeAdapter Wrapper to use an IntConsumer where a RelativeRangeConsumer is expected.IntIteratorFlyweight Fast iterator minimizing the stress on the garbage collector.ParallelAggregation These utility methods provide parallel implementations of logical aggregation operators.ParallelAggregation.ContainerCollector Collects containers grouped by their key into a RoaringBitmap, applying the supplied aggregation function to each group.ParallelAggregation.OrCollector Collects a list of containers into a single container.ReverseIntIteratorFlyweight Fast iterator minimizing the stress on the garbage collector.RoaringArray Specialized array to store the containers used by a RoaringBitmap.RoaringBatchIterator RoaringBitmap RoaringBitmap, a compressed alternative to the BitSet.RoaringBitmapPrivate Deprecated. RoaringBitmapSupplier RoaringBitmapWriter.BufferWizard RoaringBitmapWriter.FastRankRoaringBitmapWizard RoaringBitmapWriter.RoaringBitmapWizard RoaringBitmapWriter.RoaringWizard<T extends RoaringBitmap> RoaringBitmapWriter.Wizard<C extends WordStorage<C>,T extends BitmapDataProvider & AppendableStorage<C>> RunBatchIterator RunContainer This container takes the form of runs of consecutive values (effectively, run-length encoding).Util Various useful methods for roaring bitmaps. -
Exception Summary Exception Description InvalidRoaringFormat Exception thrown when attempting to deserialize a roaring bitmap from an input stream missing a cookie or having other similar anomalies.