org.roaringbitmap.art.SearchResult 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

package org.roaringbitmap.art;

class SearchResult {

  static enum Outcome {
    FOUND,
    NOT_FOUND
  }

  final Outcome outcome;

  // Equivalent to <= key
  // Contains the exact position when FOUND or the next smaller one when NOT_FOUND
  private final int lessOrEqualPos;

  // Equivalent to > key
  // Only legal when outcome is NOT_FOUND
  private final int greaterPos;

  private SearchResult(Outcome outcome, int lessOrEqualPos, int greaterPos) {
    this.outcome = outcome;
    this.lessOrEqualPos = lessOrEqualPos;
    this.greaterPos = greaterPos;
  }

  static SearchResult found(int keyPos) {
    return new SearchResult(Outcome.FOUND, keyPos, Node.ILLEGAL_IDX);
  }

  static SearchResult notFound(int lowerPos, int higherPos) {
    return new SearchResult(Outcome.NOT_FOUND, lowerPos, higherPos);
  }

  boolean hasKeyPos() {
    if (outcome == Outcome.FOUND) {
      // this would be an illegal state
      assert lessOrEqualPos != Node.ILLEGAL_IDX;
      return true;
    }
    return false;
  }

  int getKeyPos() {
    if (outcome == Outcome.FOUND) {
      return lessOrEqualPos;
    }
    throw new IllegalAccessError("Only results with outcome FOUND have this field!");
  }

  boolean hasNextSmallerPos() {
    return outcome == Outcome.NOT_FOUND && lessOrEqualPos != Node.ILLEGAL_IDX;
  }

  int getNextSmallerPos() {
    if (outcome == Outcome.NOT_FOUND) {
      return lessOrEqualPos;
    }
    throw new IllegalAccessError("Only results with outcome NOT_FOUND have this field!");
  }

  boolean hasNextLargerPos() {
    return outcome == Outcome.NOT_FOUND && greaterPos != Node.ILLEGAL_IDX;
  }

  int getNextLargerPos() {
    if (outcome == Outcome.NOT_FOUND) {
      return greaterPos;
    }
    throw new IllegalAccessError("Only results with outcome NOT_FOUND have this field!");
  }
}