Apache Lucene open-source search software
Optimize BitSetIterator#intoBitSet. (#14083)
Adrien Grandc0fc70016e1d
diff --git a/lucene/core/src/java/org/apache/lucene/util/BitSetIterator.java b/lucene/core/src/java/org/apache/lucene/util/BitSetIterator.javaindex 7546850b1dc..4d7c83057cb 100644--- a/lucene/core/src/java/org/apache/lucene/util/BitSetIterator.java+++ b/lucene/core/src/java/org/apache/lucene/util/BitSetIterator.java@@ -16,6 +16,7 @@*/package org.apache.lucene.util;+import java.io.IOException;import org.apache.lucene.search.DocIdSetIterator;/**@@ -96,4 +97,22 @@ public class BitSetIterator extends DocIdSetIterator {public long cost() {return cost;}++ @Override+ public void intoBitSet(Bits acceptDocs, int upTo, FixedBitSet bitSet, int offset)+ throws IOException {+ // TODO: Can we also optimize the case when acceptDocs is not null?+ if (acceptDocs == null+ && offset < bits.length()+ && bits instanceof FixedBitSet fixedBits+ // no bits are set between `offset` and `doc`+ && fixedBits.nextSetBit(offset) == doc+ // the whole `bitSet` is getting filled+ && (upTo - offset == bitSet.length())) {+ bitSet.orRange(fixedBits, offset);+ advance(upTo); // set the current doc+ } else {+ super.intoBitSet(acceptDocs, upTo, bitSet, offset);+ }+ }}diff --git a/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.java b/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.javaindex 1a79025c882..584f30b3baa 100644--- a/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.java+++ b/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.java@@ -338,11 +338,8 @@ public final class FixedBitSet extends BitSet {@Overridepublic void or(DocIdSetIterator iter) throws IOException {- if (BitSetIterator.getFixedBitSetOrNull(iter) != null) {- checkUnpositioned(iter);- final FixedBitSet bits = BitSetIterator.getFixedBitSetOrNull(iter);- or(bits);- } else if (iter instanceof DocBaseBitSetIterator) {+ if (iter instanceof DocBaseBitSetIterator) {+ // TODO: implement DocBaseBitSetIterator#intoBitSet insteadcheckUnpositioned(iter);DocBaseBitSetIterator baseIter = (DocBaseBitSetIterator) iter;or(baseIter.getDocBase() >> 6, baseIter.getBitSet());@@ -353,11 +350,6 @@ public final class FixedBitSet extends BitSet {}}- /** this = this OR other */- public void or(FixedBitSet other) {- or(0, other.bits, other.numWords);- }-private void or(final int otherOffsetWords, FixedBitSet other) {or(otherOffsetWords, other.bits, other.numWords);}@@ -372,6 +364,42 @@ public final class FixedBitSet extends BitSet {}}+ /**+ * Or {@code min(length(), other.length() - from} bits starting at {@code from} from {@code other}+ * into this bit set starting at 0.+ */+ void orRange(FixedBitSet other, int from) {+ int numBits = Math.min(length(), other.length() - from);+ if (numBits <= 0) {+ return;+ }+ int numFullWords = numBits >> 6;+ long[] otherBits = other.getBits();+ int wordOffset = from >> 6;+ if ((from & 0x3F) == 0) {+ // from is aligned with a long[]+ for (int i = 0; i < numFullWords; ++i) {+ bits[i] |= otherBits[wordOffset + i];+ }+ } else {+ for (int i = 0; i < numFullWords; ++i) {+ bits[i] |= (otherBits[wordOffset + i] >>> from) | (otherBits[wordOffset + i + 1] << -from);+ }+ }++ // Handle the remainder+ for (int i = numFullWords << 6; i < numBits; ++i) {+ if (other.get(from + i)) {+ set(i);+ }+ }+ }++ /** this = this OR other */+ public void or(FixedBitSet other) {+ orRange(other, 0);+ }+/** this = this XOR other */public void xor(FixedBitSet other) {xor(other.bits, other.numWords);diff --git a/lucene/core/src/test/org/apache/lucene/util/TestFixedBitSet.java b/lucene/core/src/test/org/apache/lucene/util/TestFixedBitSet.javaindex ff2bb4fd0d6..b19e17f897c 100644--- a/lucene/core/src/test/org/apache/lucene/util/TestFixedBitSet.java+++ b/lucene/core/src/test/org/apache/lucene/util/TestFixedBitSet.java@@ -17,7 +17,9 @@package org.apache.lucene.util;import java.io.IOException;+import java.util.ArrayList;import java.util.Arrays;+import java.util.List;import java.util.Random;import org.apache.lucene.search.DocIdSetIterator;import org.apache.lucene.tests.util.BaseBitSetTestCase;@@ -642,4 +644,44 @@ public class TestFixedBitSet extends BaseBitSetTestCase<FixedBitSet> {set.set(1028);assertFalse(set.scanIsEmpty());}++ public void testOrRange() {+ FixedBitSet set1 = new FixedBitSet(1_000);+ FixedBitSet set2 = new FixedBitSet(10_000);+ for (int i = 0; i < set2.length(); i += 3) {+ set2.set(i);+ }++ // Check different values of `offset`+ List<Integer> offsets = new ArrayList<>();+ for (int offset = 64; offset < 128; ++offset) {+ // Test all possible alignments+ offsets.add(offset);+ }+ for (int offset = set2.length() - 128; offset < set2.length() - 64; ++offset) {+ // Again, test all possible alignments, but this time we stop or-ing bits when exceeding the+ // size of set2 rather than set1+ offsets.add(offset);+ }++ for (int offset : offsets) {+ set1.clear();+ for (int i = 0; i < set1.length(); i += 10) {+ set1.set(i);+ }+ set1.orRange(set2, offset);+ int upTo = Math.min(set1.length(), set2.length() - offset);+ for (int i = 0; i < set1.length(); ++i) {+ if (i % 10 == 0 || i >= upTo) {+ // These bits were set before, they should still be set+ assertEquals(i % 10 == 0, set1.get(i));+ } else if ((offset + i) % 3 == 0) {+ // These bits were set in set1, should be set in set2+ assertTrue(set1.get(i));+ } else {+ assertFalse(set1.get(i));+ }+ }+ }+ }}