Apache Lucene open-source search software
add BitSet.clear() (#12268)
Jonathan Ellis431dc7b4151e
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txtindex af8233bf444..40075822e84 100644--- a/lucene/CHANGES.txt+++ b/lucene/CHANGES.txt@@ -116,6 +116,10 @@ OtherAPI Changes---------------------++* GITHUB#12268: Add BitSet.clear() without parameters for clearing the entire set+ (Jonathan Ellis)+(No changes)New Featuresdiff --git a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/TrigramAutomaton.java b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/TrigramAutomaton.javaindex dfe994ccf82..f4404e4bcf0 100644--- a/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/TrigramAutomaton.java+++ b/lucene/analysis/common/src/java/org/apache/lucene/analysis/hunspell/TrigramAutomaton.java@@ -79,7 +79,7 @@ class TrigramAutomaton {}int ngramScore(CharsRef s2) {- countedSubstrings.clear(0, countedSubstrings.length());+ countedSubstrings.clear();int score1 = 0, score2 = 0, score3 = 0; // scores for substrings of length 1, 2 and 3diff --git a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/IndexedDISI.java b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/IndexedDISI.javaindex fc82ce58886..639bdbd7333 100644--- a/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/IndexedDISI.java+++ b/lucene/backward-codecs/src/java/org/apache/lucene/backward_codecs/lucene80/IndexedDISI.java@@ -219,7 +219,7 @@ final class IndexedDISI extends DocIdSetIterator {// Flush blockflush(prevBlock, buffer, blockCardinality, denseRankPower, out);// Reset for next block- buffer.clear(0, buffer.length());+ buffer.clear();totalCardinality += blockCardinality;blockCardinality = 0;}@@ -233,7 +233,7 @@ final class IndexedDISI extends DocIdSetIterator {jumps, out.getFilePointer() - origo, totalCardinality, jumpBlockIndex, prevBlock + 1);totalCardinality += blockCardinality;flush(prevBlock, buffer, blockCardinality, denseRankPower, out);- buffer.clear(0, buffer.length());+ buffer.clear();prevBlock++;}final int lastBlock =diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/IndexedDISI.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/IndexedDISI.javaindex 8da289e3ad3..205892d2fe9 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/IndexedDISI.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/IndexedDISI.java@@ -220,7 +220,7 @@ public final class IndexedDISI extends DocIdSetIterator {// Flush blockflush(prevBlock, buffer, blockCardinality, denseRankPower, out);// Reset for next block- buffer.clear(0, buffer.length());+ buffer.clear();totalCardinality += blockCardinality;blockCardinality = 0;}@@ -234,7 +234,7 @@ public final class IndexedDISI extends DocIdSetIterator {jumps, out.getFilePointer() - origo, totalCardinality, jumpBlockIndex, prevBlock + 1);totalCardinality += blockCardinality;flush(prevBlock, buffer, blockCardinality, denseRankPower, out);- buffer.clear(0, buffer.length());+ buffer.clear();prevBlock++;}final int lastBlock =diff --git a/lucene/core/src/java/org/apache/lucene/util/BitSet.java b/lucene/core/src/java/org/apache/lucene/util/BitSet.javaindex f8b8ba65a59..c5d84833b28 100644--- a/lucene/core/src/java/org/apache/lucene/util/BitSet.java+++ b/lucene/core/src/java/org/apache/lucene/util/BitSet.java@@ -43,6 +43,16 @@ public abstract class BitSet implements Bits, Accountable {return set;}+ /**+ * Clear all the bits of the set.+ *+ * <p>Depending on the implementation, this may be significantly faster than clear(0, length).+ */+ public void clear() {+ // default implementation for compatibility+ clear(0, length());+ }+/** Set the bit at <code>i</code>. */public abstract void set(int i);diff --git a/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.java b/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.javaindex 5566bd0c483..ebf626a777d 100644--- a/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.java+++ b/lucene/core/src/java/org/apache/lucene/util/FixedBitSet.java@@ -147,6 +147,11 @@ public final class FixedBitSet extends BitSet {assert verifyGhostBitsClear();}+ @Override+ public void clear() {+ Arrays.fill(bits, 0L);+ }+/*** Checks if the bits past numBits are clear. Some methods rely on this implicit assumption:* search for "Depends on the ghost bits being clear!"diff --git a/lucene/core/src/java/org/apache/lucene/util/SparseFixedBitSet.java b/lucene/core/src/java/org/apache/lucene/util/SparseFixedBitSet.javaindex 49d61614e86..b4ebe3cfc59 100644--- a/lucene/core/src/java/org/apache/lucene/util/SparseFixedBitSet.java+++ b/lucene/core/src/java/org/apache/lucene/util/SparseFixedBitSet.java@@ -17,6 +17,7 @@package org.apache.lucene.util;import java.io.IOException;+import java.util.Arrays;import org.apache.lucene.search.DocIdSetIterator;/**@@ -73,6 +74,17 @@ public class SparseFixedBitSet extends BitSet {+ RamUsageEstimator.shallowSizeOf(bits);}+ @Override+ public void clear() {+ Arrays.fill(bits, null);+ Arrays.fill(indices, 0L);+ nonZeroLongCount = 0;+ ramBytesUsed =+ BASE_RAM_BYTES_USED+ + RamUsageEstimator.sizeOf(indices)+ + RamUsageEstimator.shallowSizeOf(bits);+ }+@Overridepublic int length() {return length;diff --git a/lucene/core/src/java/org/apache/lucene/util/automaton/Operations.java b/lucene/core/src/java/org/apache/lucene/util/automaton/Operations.javaindex 8448dfc8795..cc53b657fa4 100644--- a/lucene/core/src/java/org/apache/lucene/util/automaton/Operations.java+++ b/lucene/core/src/java/org/apache/lucene/util/automaton/Operations.java@@ -1094,7 +1094,7 @@ public final class Operations {FixedBitSet tmp = current;current = next;next = tmp;- next.clear(0, next.length());+ next.clear();}return builder.toString();}diff --git a/lucene/core/src/java/org/apache/lucene/util/hnsw/HnswGraphSearcher.java b/lucene/core/src/java/org/apache/lucene/util/hnsw/HnswGraphSearcher.javaindex d6e63f483b2..5bc71816946 100644--- a/lucene/core/src/java/org/apache/lucene/util/hnsw/HnswGraphSearcher.java+++ b/lucene/core/src/java/org/apache/lucene/util/hnsw/HnswGraphSearcher.java@@ -339,7 +339,7 @@ public class HnswGraphSearcher<T> {if (visited.length() < capacity) {visited = FixedBitSet.ensureCapacity((FixedBitSet) visited, capacity);}- visited.clear(0, visited.length());+ visited.clear();}/**diff --git a/lucene/facet/src/java/org/apache/lucene/facet/range/OverlappingLongRangeCounter.java b/lucene/facet/src/java/org/apache/lucene/facet/range/OverlappingLongRangeCounter.javaindex 3c9ae7ebd7c..b478e3994e1 100644--- a/lucene/facet/src/java/org/apache/lucene/facet/range/OverlappingLongRangeCounter.java+++ b/lucene/facet/src/java/org/apache/lucene/facet/range/OverlappingLongRangeCounter.java@@ -84,7 +84,7 @@ class OverlappingLongRangeCounter extends LongRangeCounter {if (multiValuedDocElementaryIntervalHits == null) {multiValuedDocElementaryIntervalHits = new FixedBitSet(boundaries.length);} else {- multiValuedDocElementaryIntervalHits.clear(0, multiValuedDocElementaryIntervalHits.length());+ multiValuedDocElementaryIntervalHits.clear();}}@@ -103,7 +103,7 @@ class OverlappingLongRangeCounter extends LongRangeCounter {if (multiValuedDocRangeHits == null) {multiValuedDocRangeHits = new FixedBitSet(rangeCount());} else {- multiValuedDocRangeHits.clear(0, multiValuedDocRangeHits.length());+ multiValuedDocRangeHits.clear();}elementaryIntervalUpto = 0;rollupMultiValued(root);diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/util/BaseBitSetTestCase.java b/lucene/test-framework/src/java/org/apache/lucene/tests/util/BaseBitSetTestCase.javaindex 1bb5e500a44..cbce97d87ac 100644--- a/lucene/test-framework/src/java/org/apache/lucene/tests/util/BaseBitSetTestCase.java+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/util/BaseBitSetTestCase.java@@ -170,6 +170,22 @@ public abstract class BaseBitSetTestCase<T extends BitSet> extends LuceneTestCas}}+ /** Test the {@link BitSet#clear()} method. */+ public void testClearAll() throws IOException {+ Random random = random();+ final int numBits = 1 + random.nextInt(100000);+ for (float percentSet : new float[] {0, 0.01f, 0.1f, 0.5f, 0.9f, 0.99f, 1f}) {+ BitSet set1 = new JavaUtilBitSet(randomSet(numBits, percentSet), numBits);+ T set2 = copyOf(set1, numBits);+ final int iters = atLeast(random, 10);+ for (int i = 0; i < iters; ++i) {+ set1.clear();+ set2.clear();+ assertEquals(set1, set2, numBits);+ }+ }+ }+private DocIdSet randomCopy(BitSet set, int numBits) throws IOException {switch (random().nextInt(5)) {case 0:@@ -241,6 +257,11 @@ public abstract class BaseBitSetTestCase<T extends BitSet> extends LuceneTestCasthis.numBits = numBits;}+ @Override+ public void clear() {+ bitSet.clear();+ }+@Overridepublic void clear(int index) {bitSet.clear(index);