Apache Lucene open-source search software
Fix vector scorer interface consistency (#13365)
Benjamin Trentfc12cc1847e3
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapByteVectorValues.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapByteVectorValues.javaindex b1f0972f4f9..f45158eadac 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapByteVectorValues.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapByteVectorValues.java@@ -376,7 +376,7 @@ public abstract class OffHeapByteVectorValues extends ByteVectorValues@Overridepublic VectorScorer scorer(byte[] query) {- throw new UnsupportedOperationException();+ return null;}}}diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapFloatVectorValues.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapFloatVectorValues.javaindex 52753325f6b..1f61283b500 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapFloatVectorValues.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene95/OffHeapFloatVectorValues.java@@ -365,7 +365,7 @@ public abstract class OffHeapFloatVectorValues extends FloatVectorValues@Overridepublic VectorScorer scorer(float[] query) {- throw new UnsupportedOperationException();+ return null;}}}diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsReader.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsReader.javaindex 6623ad0ab2b..5a20770bb98 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsReader.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsReader.java@@ -431,7 +431,7 @@ public final class Lucene99ScalarQuantizedVectorsReader extends FlatVectorsReade@Overridepublic VectorScorer scorer(float[] query) throws IOException {- return quantizedVectorValues.vectorScorer(query);+ return quantizedVectorValues.scorer(query);}}}diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsWriter.javaindex 278e60e0976..ae13be02467 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsWriter.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/Lucene99ScalarQuantizedVectorsWriter.java@@ -1023,7 +1023,7 @@ public final class Lucene99ScalarQuantizedVectorsWriter extends FlatVectorsWrite}@Override- public VectorScorer vectorScorer(float[] target) throws IOException {+ public VectorScorer scorer(float[] target) throws IOException {throw new UnsupportedOperationException();}}@@ -1096,7 +1096,7 @@ public final class Lucene99ScalarQuantizedVectorsWriter extends FlatVectorsWrite}@Override- public VectorScorer vectorScorer(float[] target) throws IOException {+ public VectorScorer scorer(float[] target) throws IOException {throw new UnsupportedOperationException();}@@ -1202,7 +1202,7 @@ public final class Lucene99ScalarQuantizedVectorsWriter extends FlatVectorsWrite}@Override- public VectorScorer vectorScorer(float[] target) throws IOException {+ public VectorScorer scorer(float[] target) throws IOException {throw new UnsupportedOperationException();}}diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/OffHeapQuantizedByteVectorValues.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/OffHeapQuantizedByteVectorValues.javaindex 5fee4b1cb08..655dcca1166 100644--- a/lucene/core/src/java/org/apache/lucene/codecs/lucene99/OffHeapQuantizedByteVectorValues.java+++ b/lucene/core/src/java/org/apache/lucene/codecs/lucene99/OffHeapQuantizedByteVectorValues.java@@ -268,7 +268,7 @@ public abstract class OffHeapQuantizedByteVectorValues extends QuantizedByteVect}@Override- public VectorScorer vectorScorer(float[] target) throws IOException {+ public VectorScorer scorer(float[] target) throws IOException {DenseOffHeapVectorValues copy = copy();RandomVectorScorer vectorScorer =vectorsScorer.getRandomVectorScorer(similarityFunction, copy, target);@@ -370,7 +370,7 @@ public abstract class OffHeapQuantizedByteVectorValues extends QuantizedByteVect}@Override- public VectorScorer vectorScorer(float[] target) throws IOException {+ public VectorScorer scorer(float[] target) throws IOException {SparseOffHeapVectorValues copy = copy();RandomVectorScorer vectorScorer =vectorsScorer.getRandomVectorScorer(similarityFunction, copy, target);@@ -457,8 +457,8 @@ public abstract class OffHeapQuantizedByteVectorValues extends QuantizedByteVect}@Override- public VectorScorer vectorScorer(float[] target) {- throw new UnsupportedOperationException();+ public VectorScorer scorer(float[] target) {+ return null;}}}diff --git a/lucene/core/src/java/org/apache/lucene/index/ByteVectorValues.java b/lucene/core/src/java/org/apache/lucene/index/ByteVectorValues.javaindex d04d52b0dcf..d33ca1ca354 100644--- a/lucene/core/src/java/org/apache/lucene/index/ByteVectorValues.java+++ b/lucene/core/src/java/org/apache/lucene/index/ByteVectorValues.java@@ -83,7 +83,7 @@ public abstract class ByteVectorValues extends DocIdSetIterator {* iteration over the scorer will not affect the iteration of this {@link ByteVectorValues}.** @param query the query vector- * @return a {@link VectorScorer} instance+ * @return a {@link VectorScorer} instance or null*/public abstract VectorScorer scorer(byte[] query) throws IOException;}diff --git a/lucene/core/src/java/org/apache/lucene/index/FloatVectorValues.java b/lucene/core/src/java/org/apache/lucene/index/FloatVectorValues.javaindex 9a5bb31b0c6..e5dbc620f5c 100644--- a/lucene/core/src/java/org/apache/lucene/index/FloatVectorValues.java+++ b/lucene/core/src/java/org/apache/lucene/index/FloatVectorValues.java@@ -84,7 +84,7 @@ public abstract class FloatVectorValues extends DocIdSetIterator {* iteration of this {@link FloatVectorValues}.** @param query the query vector- * @return a {@link VectorScorer} instance+ * @return a {@link VectorScorer} instance or null*/public abstract VectorScorer scorer(float[] query) throws IOException;}diff --git a/lucene/core/src/java/org/apache/lucene/search/AbstractVectorSimilarityQuery.java b/lucene/core/src/java/org/apache/lucene/search/AbstractVectorSimilarityQuery.javaindex 7bd21d99b30..98868ec0d53 100644--- a/lucene/core/src/java/org/apache/lucene/search/AbstractVectorSimilarityQuery.java+++ b/lucene/core/src/java/org/apache/lucene/search/AbstractVectorSimilarityQuery.java@@ -259,6 +259,9 @@ abstract class AbstractVectorSimilarityQuery extends Query {VectorScorer scorer,DocIdSetIterator acceptDocs,float threshold) {+ if (scorer == null) {+ return null;+ }float[] cachedScore = new float[1];DocIdSetIterator vectorIterator = scorer.iterator();DocIdSetIterator conjunction =diff --git a/lucene/core/src/java/org/apache/lucene/search/FloatVectorSimilarityValuesSource.java b/lucene/core/src/java/org/apache/lucene/search/FloatVectorSimilarityValuesSource.javaindex 3bf4c0a1887..8a43644cc4e 100644--- a/lucene/core/src/java/org/apache/lucene/search/FloatVectorSimilarityValuesSource.java+++ b/lucene/core/src/java/org/apache/lucene/search/FloatVectorSimilarityValuesSource.java@@ -36,29 +36,6 @@ class FloatVectorSimilarityValuesSource extends VectorSimilarityValuesSource {this.queryVector = vector;}- @Override- public DoubleValues getValues(LeafReaderContext ctx, DoubleValues scores) throws IOException {- final FloatVectorValues vectorValues = ctx.reader().getFloatVectorValues(fieldName);- if (vectorValues == null) {- FloatVectorValues.checkField(ctx.reader(), fieldName);- return DoubleValues.EMPTY;- }- return new DoubleValues() {- private final VectorScorer scorer = vectorValues.scorer(queryVector);- private final DocIdSetIterator iterator = scorer.iterator();-- @Override- public double doubleValue() throws IOException {- return scorer.score();- }-- @Override- public boolean advanceExact(int doc) throws IOException {- return doc >= iterator.docID() && (iterator.docID() == doc || iterator.advance(doc) == doc);- }- };- }-@Overridepublic VectorScorer getScorer(LeafReaderContext ctx) throws IOException {final FloatVectorValues vectorValues = ctx.reader().getFloatVectorValues(fieldName);diff --git a/lucene/core/src/java/org/apache/lucene/util/quantization/QuantizedByteVectorValues.java b/lucene/core/src/java/org/apache/lucene/util/quantization/QuantizedByteVectorValues.javaindex c277abfc634..a0fe957fecb 100644--- a/lucene/core/src/java/org/apache/lucene/util/quantization/QuantizedByteVectorValues.java+++ b/lucene/core/src/java/org/apache/lucene/util/quantization/QuantizedByteVectorValues.java@@ -51,7 +51,7 @@ public abstract class QuantizedByteVectorValues extends DocIdSetIterator {* Return a {@link VectorScorer} for the given query vector.** @param query the query vector- * @return a {@link VectorScorer} instance+ * @return a {@link VectorScorer} instance or null*/- public abstract VectorScorer vectorScorer(float[] query) throws IOException;+ public abstract VectorScorer scorer(float[] query) throws IOException;}diff --git a/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenByteKnnVectorQuery.java b/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenByteKnnVectorQuery.javaindex 8c6f0f98470..456a885b49a 100644--- a/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenByteKnnVectorQuery.java+++ b/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenByteKnnVectorQuery.java@@ -92,6 +92,9 @@ public class DiversifyingChildrenByteKnnVectorQuery extends KnnByteVectorQuery {}VectorScorer scorer = byteVectorValues.scorer(query);+ if (scorer == null) {+ return NO_RESULTS;+ }DiversifyingChildrenFloatKnnVectorQuery.DiversifyingChildrenVectorScorer vectorScorer =new DiversifyingChildrenFloatKnnVectorQuery.DiversifyingChildrenVectorScorer(acceptIterator, parentBitSet, scorer);diff --git a/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenFloatKnnVectorQuery.java b/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenFloatKnnVectorQuery.javaindex 513da619cae..7b5a656d141 100644--- a/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenFloatKnnVectorQuery.java+++ b/lucene/join/src/java/org/apache/lucene/search/join/DiversifyingChildrenFloatKnnVectorQuery.java@@ -90,10 +90,13 @@ public class DiversifyingChildrenFloatKnnVectorQuery extends KnnFloatVectorQueryif (parentBitSet == null) {return NO_RESULTS;}+ VectorScorer floatVectorScorer = floatVectorValues.scorer(query);+ if (floatVectorScorer == null) {+ return NO_RESULTS;+ }DiversifyingChildrenVectorScorer vectorScorer =- new DiversifyingChildrenVectorScorer(- acceptIterator, parentBitSet, floatVectorValues.scorer(query));+ new DiversifyingChildrenVectorScorer(acceptIterator, parentBitSet, floatVectorScorer);final int queueSize = Math.min(k, Math.toIntExact(acceptIterator.cost()));HitQueue queue = new HitQueue(queueSize, true);TotalHits.Relation relation = TotalHits.Relation.EQUAL_TO;diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/index/BaseKnnVectorsFormatTestCase.java b/lucene/test-framework/src/java/org/apache/lucene/tests/index/BaseKnnVectorsFormatTestCase.javaindex 75cb1a52e0d..bfafd19a75c 100644--- a/lucene/test-framework/src/java/org/apache/lucene/tests/index/BaseKnnVectorsFormatTestCase.java+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/index/BaseKnnVectorsFormatTestCase.java@@ -754,6 +754,10 @@ public abstract class BaseKnnVectorsFormatTestCase extends BaseIndexFileFormatTeif (vectorValues == null) {continue;}+ if (vectorValues.size() == 0) {+ assertNull(vectorValues.scorer(vectorToScore));+ continue;+ }VectorScorer scorer = vectorValues.scorer(vectorToScore);assertNotNull(scorer);DocIdSetIterator iterator = scorer.iterator();@@ -809,6 +813,10 @@ public abstract class BaseKnnVectorsFormatTestCase extends BaseIndexFileFormatTeif (vectorValues == null) {continue;}+ if (vectorValues.size() == 0) {+ assertNull(vectorValues.scorer(vectorToScore));+ continue;+ }VectorScorer scorer = vectorValues.scorer(vectorToScore);assertNotNull(scorer);DocIdSetIterator iterator = scorer.iterator();