com.metamx.collections.bitmap

Class RoaringBitmapFactory

java.lang.Object

com.metamx.collections.bitmap.RoaringBitmapFactory

All Implemented Interfaces:

BitmapFactory

public class RoaringBitmapFactory
extends Object
implements BitmapFactory

As the name suggests, this class instantiates bitmaps of the types WrappedRoaringBitmap and WrappedImmutableRoaringBitmap.

Constructor Summary

Constructors

Constructor and Description
RoaringBitmapFactory()
RoaringBitmapFactory(boolean compressRunOnSerialization)

Method Summary

Methods

Modifier and Type	Method and Description
ImmutableBitmap	complement(ImmutableBitmap b)
ImmutableBitmap	complement(ImmutableBitmap b, int length)
ImmutableBitmap	intersection(Iterable<ImmutableBitmap> b) Compute the intersection (bitwise-AND) of a set of bitmaps.
ImmutableBitmap	makeEmptyImmutableBitmap()
MutableBitmap	makeEmptyMutableBitmap() Create a new empty bitmap
ImmutableBitmap	makeImmutableBitmap(MutableBitmap mutableBitmap)
ImmutableBitmap	mapImmutableBitmap(ByteBuffer b) Given a ByteBuffer pointing at a serialized version of a bitmap, instantiate an immutable mapped bitmap.
ImmutableBitmap	union(Iterable<ImmutableBitmap> b) Compute the union (bitwise-OR) of a set of bitmaps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoaringBitmapFactory

public RoaringBitmapFactory()

RoaringBitmapFactory

public RoaringBitmapFactory(boolean compressRunOnSerialization)

Method Detail

makeEmptyMutableBitmap

public MutableBitmap makeEmptyMutableBitmap()

Description copied from interface: BitmapFactory

Create a new empty bitmap

Specified by:

makeEmptyMutableBitmap in interface BitmapFactory

Returns:

the new bitmap

makeEmptyImmutableBitmap

public ImmutableBitmap makeEmptyImmutableBitmap()

Specified by:

makeEmptyImmutableBitmap in interface BitmapFactory

makeImmutableBitmap

public ImmutableBitmap makeImmutableBitmap(MutableBitmap mutableBitmap)

Specified by:

makeImmutableBitmap in interface BitmapFactory

mapImmutableBitmap

public ImmutableBitmap mapImmutableBitmap(ByteBuffer b)

Description copied from interface: BitmapFactory

Given a ByteBuffer pointing at a serialized version of a bitmap, instantiate an immutable mapped bitmap. When using RoaringBitmap (with the RoaringBitmapFactory class), it is not necessary for b.limit() to indicate the end of the serialized content whereas it is critical to set b.limit() appropriately with ConciseSet (with the ConciseBitmapFactory).

Specified by:

mapImmutableBitmap in interface BitmapFactory

Parameters:

b - the input byte buffer

Returns:

the new bitmap

union

public ImmutableBitmap union(Iterable<ImmutableBitmap> b)

Description copied from interface: BitmapFactory

Compute the union (bitwise-OR) of a set of bitmaps. They are assumed to be instances of of the proper WrappedConciseBitmap otherwise a ClassCastException is thrown.

Specified by:

union in interface BitmapFactory

Parameters:

b - input ImmutableGenericBitmap objects

Returns:

the union.

intersection

public ImmutableBitmap intersection(Iterable<ImmutableBitmap> b)

Description copied from interface: BitmapFactory

Compute the intersection (bitwise-AND) of a set of bitmaps. They are assumed to be instances of of the proper WrappedConciseBitmap otherwise a ClassCastException is thrown.

Specified by:

intersection in interface BitmapFactory

Parameters:

b - input ImmutableGenericBitmap objects

Returns:

the union.

complement

public ImmutableBitmap complement(ImmutableBitmap b)

Specified by:

complement in interface BitmapFactory

complement

public ImmutableBitmap complement(ImmutableBitmap b,
                         int length)

Specified by:

complement in interface BitmapFactory