Skip to content

Apache Lucene open-source search software

Upgrade DocIdSetBuilder to use FixedBitSet eagerly once exceeding the threshold (#16089)

kkewwei1169cd2007d3
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index d107f50a94d..65b85dc4a0d 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -639,6 +639,8 @@ Optimizations
* GITHUB#16783: Fix performance bug in DirectoryTaxonomyReader#getBulkOrdinals that broke its
ord -> FacetLabel cache such that it always missed when it should have hit. (Alex Baranov)
+* GITHUB#16089: Upgrade DocIdSetBuilder to use FixedBitSet eagerly once exceeding the threshold (Ke Wei)
+
Bug Fixes
---------------------
diff --git a/lucene/core/src/java/org/apache/lucene/search/PointRangeQuery.java b/lucene/core/src/java/org/apache/lucene/search/PointRangeQuery.java
index 4b349afe2b5..2014faa0e37 100644
--- a/lucene/core/src/java/org/apache/lucene/search/PointRangeQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/PointRangeQuery.java
@@ -319,6 +319,11 @@ public abstract class PointRangeQuery extends Query {
return new BitSetIterator(result, cost[0]);
}
+ if (cost != -1 && numDims == 1) {
+ // A 1D range has at most two crossing leaves, so its estimate is accurate enough
+ // to choose the builder representation up front.
+ result.expectMore(cost);
+ }
values.intersect(visitor);
return result.build().iterator();
}
diff --git a/lucene/core/src/java/org/apache/lucene/util/DocIdSetBuilder.java b/lucene/core/src/java/org/apache/lucene/util/DocIdSetBuilder.java
index 3ac9293681d..c8f5aebca62 100644
--- a/lucene/core/src/java/org/apache/lucene/util/DocIdSetBuilder.java
+++ b/lucene/core/src/java/org/apache/lucene/util/DocIdSetBuilder.java
@@ -231,6 +231,20 @@ public final class DocIdSetBuilder {
return adder;
}
+ /**
+ * If the builder is still in buffer (sparse) mode and this hint indicates the total number of
+ * docs will exceed the threshold above which a FixedBitSet is preferred, eagerly upgrade to
+ * FixedBitSet.
+ */
+ public void expectMore(long expectedDocs) {
+ if (bitSet != null || expectedDocs <= 0) {
+ return;
+ }
+ if ((long) totalAllocated + expectedDocs > threshold) {
+ upgradeToBitSet();
+ }
+ }
+
private void ensureBufferCapacity(int numDocs) {
if (buffers.isEmpty()) {
addBuffer(additionalCapacity(numDocs));
diff --git a/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java b/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java
index 284942f5151..1f661be3ffc 100644
--- a/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java
+++ b/lucene/core/src/test/org/apache/lucene/util/TestDocIdSetBuilder.java
@@ -87,6 +87,23 @@ public class TestDocIdSetBuilder extends LuceneTestCase {
assertEquals(new BitDocIdSet(ref), result);
}
+ public void testExpectMoreUpgradesToBitSet() throws IOException {
+ final int maxDoc = 1 << 14;
+ DocIdSetBuilder builder = new DocIdSetBuilder(maxDoc);
+ builder.grow(1).add(7);
+
+ builder.expectMore((maxDoc >>> 7) + 1L);
+ builder.grow(1).add(11);
+
+ DocIdSet result = builder.build();
+ assertTrue(result instanceof BitDocIdSet);
+ DocIdSetIterator iterator = result.iterator();
+ assertEquals(7, iterator.nextDoc());
+ assertEquals(11, iterator.nextDoc());
+ assertEquals(DocIdSetIterator.NO_MORE_DOCS, iterator.nextDoc());
+ assertEquals(2, iterator.cost());
+ }
+
public void testRandom() throws IOException {
final int maxDoc =
TEST_NIGHTLY