org.roaringbitmap.BitmapDataProvider 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.
 */

package org.roaringbitmap;

/**
 * Representing a general bitmap interface.
 *
 */
public interface BitmapDataProvider extends ImmutableBitmapDataProvider {
  /**
   * set the value to "true", whether it already appears or not.
   *
   * @param x integer value
   */
  void add(int x);

  /**
   * Add a range of values to the bitmap
   * @param min the inclusive minimum value
   * @param sup the exclusive maximum value
   */
  void add(long min, long sup);

  /**
   * If present remove the specified integers (effectively, sets its bit value to false)
   *
   * @param x integer value representing the index in a bitmap
   */
  void remove(int x);

  /**
   * Recover allocated but unused memory.
   */
  void trim();
}