org.roaringbitmap.ContainerPointer 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;

/**
 * 
 * This interface allows you to iterate over the containers in a roaring bitmap.
 *
 */
public interface ContainerPointer extends Comparable, Cloneable  {
  /**
   * Move to the next container
   */
  void advance();


  /**
   * Create a copy
   * 
   * @return return a clone of this pointer
   */
  ContainerPointer clone();  

  /**
   * Return the cardinality of the current container
   * 
   * @return the cardinality
   */
  int getCardinality();

  /**
   * This method can be used to check whether there is current a valid container as it returns null
   * when there is not.
   * 
   * @return null or the current container
   */
  Container getContainer();

  /**
   * Check whether the current container is a bitmap container.
   * 
   * @return whether it is a bitmap container
   */
  boolean isBitmapContainer();

  /**
   * Check whether the current container is a run container.
   * 
   * @return whether it is a run container
   */
  boolean isRunContainer();

  /**
   * The key is a 16-bit integer that indicates the position of the container in the roaring bitmap.
   * To be interpreted as an unsigned integer.
   * 
   * @return the key
   */
  char key();
}