org.roaringbitmap.buffer.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of RoaringBitmap Show documentation

Roaring bitmaps are compressed bitmaps (also called bitsets) which tend to outperform conventional compressed bitmaps such as WAH or Concise.

There is a newer version: 1.3.0

Show newest version

/*
 * (c) the authors Licensed under the Apache License, Version 2.0.
 */



/**
 * The org.roaringbitmap.buffer package  provides
 * two classes ({@link org.roaringbitmap.buffer.MutableRoaringBitmap} and 
 * ({@link org.roaringbitmap.buffer.ImmutableRoaringBitmap}) that   users
 * can rely upon for fast set of integers.
 * It differs from the org.roaringbitmap in that
 * the backing stores are ByteBuffers. 
 * 
 * Initially, one wants to construct a bitmap using
 * the MutableRoaringBitmap class. After serialization,
 * one can memory-map an ImmutableRoaringBitmap to the
 * serialized bytes, enabling off-heap processing.
 * 
 *  * {@code
 *      import org.roaringbitmap.buffer.*;
 *
 *      //...
 *
 *      MutableRoaringBitmap r1 = new MutableRoaringBitmap();
 *      for(int k = 4000; k<4255;++k) r1.add(k);
 *      
 *      MutableRoaringBitmap r2 = new MutableRoaringBitmap();
 *      for(int k = 1000; k<4255; k+=2) r2.add(k);
 *
 *      MutableRoaringBitmap union = ImmutableRoaringBitmap.or(r1, r2);
 *      MutableRoaringBitmap intersection = ImmutableRoaringBitmap.and(r1, r2);
 *
 *      //...
 *      DataOutputStream wheretoserialize = ...
 *      r1.runOptimize(); // can help compression
 *      r1.serialize(wheretoserialize);
 * }
 * 
 *
 */
package org.roaringbitmap.buffer;