Applied lucene.bug.VectorSimilarityFunction.doubleVal.patch.txt (#15329)

Author: dweiss

lucene/CHANGES.txt

@@ -147,6 +147,9 @@ API Changes
 
 New Features
 ---------------------
+* GITHUB#15328: VectorSimilarityFunction.getValues() now implements doubleVal allowing its
+  use in FunctionScoreQuery. (hossman)
+
 * GITHUB#14565: Add ParentsChildrenBlockJoinQuery that supports parent and child filter in the same query
   along with limiting number of child documents to retrieve per parent. (Jinny Wang)
 

lucene/queries/src/java/org/apache/lucene/queries/function/valuesource/VectorSimilarityFunction.java

@@ -52,6 +52,11 @@ public float floatVal(int doc) throws IOException {
         return func(doc, vector1Vals, vector2Vals);
       }
 
+      @Override
+      public double doubleVal(int doc) throws IOException {
+        return floatVal(doc);
+      }
+
       @Override
       public String strVal(int doc) throws IOException {
         return Float.toString(floatVal(doc));

lucene/queries/src/test/org/apache/lucene/queries/function/TestKnnVectorSimilarityFunctions.java

@@ -34,6 +34,7 @@
 import org.apache.lucene.queries.function.valuesource.FloatKnnVectorFieldSource;
 import org.apache.lucene.queries.function.valuesource.FloatVectorSimilarityFunction;
 import org.apache.lucene.search.IndexSearcher;
+import org.apache.lucene.search.MatchAllDocsQuery;
 import org.apache.lucene.search.Query;
 import org.apache.lucene.search.ScoreDoc;
 import org.apache.lucene.search.Sort;
@@ -113,8 +114,7 @@ public void vectorSimilarity_floatConstantVectors_shouldReturnFloatSimilarity()
     var v1 = new ConstKnnFloatValueSource(new float[] {1, 2, 3});
     var v2 = new ConstKnnFloatValueSource(new float[] {5, 4, 1});
     assertHits(
-        new FunctionQuery(
-            new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.04f, 0.04f});
   }
 
@@ -123,8 +123,7 @@ public void vectorSimilarity_byteConstantVectors_shouldReturnFloatSimilarity() t
     var v1 = new ConstKnnByteVectorValueSource(new byte[] {1, 2, 3});
     var v2 = new ConstKnnByteVectorValueSource(new byte[] {2, 5, 6});
     assertHits(
-        new FunctionQuery(
-            new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.05f, 0.05f});
   }
 
@@ -133,8 +132,7 @@ public void vectorSimilarity_floatFieldVectors_shouldReturnFloatSimilarity() thr
     var v1 = new FloatKnnVectorFieldSource("knnFloatField1");
     var v2 = new FloatKnnVectorFieldSource("knnFloatField2");
     assertHits(
-        new FunctionQuery(
-            new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.049776014f, 0.049776014f});
   }
 
@@ -143,8 +141,7 @@ public void vectorSimilarity_byteFieldVectors_shouldReturnFloatSimilarity() thro
     var v1 = new ByteKnnVectorFieldSource("knnByteField1");
     var v2 = new ByteKnnVectorFieldSource("knnByteField2");
     assertHits(
-        new FunctionQuery(
-            new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.1f, 0.1f});
   }
 
@@ -154,8 +151,7 @@ public void vectorSimilarity_FloatConstAndFloatFieldVectors_shouldReturnFloatSim
     var v1 = new ConstKnnFloatValueSource(new float[] {1, 2, 4});
     var v2 = new FloatKnnVectorFieldSource("knnFloatField1");
     assertHits(
-        new FunctionQuery(
-            new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.5f, 0.5f});
   }
 
@@ -165,8 +161,7 @@ public void vectorSimilarity_ByteConstAndByteFieldVectors_shouldReturnFloatSimil
     var v1 = new ConstKnnByteVectorValueSource(new byte[] {1, 2, 4});
     var v2 = new ByteKnnVectorFieldSource("knnByteField1");
     assertHits(
-        new FunctionQuery(
-            new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.5f, 0.5f});
   }
 
@@ -175,8 +170,7 @@ public void vectorSimilarity_missingFloatVectorField_shouldReturnZero() throws E
     var v1 = new ConstKnnFloatValueSource(new float[] {2.f, 1.f, 1.f});
     var v2 = new FloatKnnVectorFieldSource("knnFloatField3");
     assertHits(
-        new FunctionQuery(
-            new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new FloatVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.5f, 0.f});
   }
 
@@ -185,8 +179,7 @@ public void vectorSimilarity_missingByteVectorField_shouldReturnZero() throws Ex
     var v1 = new ConstKnnByteVectorValueSource(new byte[] {2, 1, 1});
     var v2 = new ByteKnnVectorFieldSource("knnByteField3");
     assertHits(
-        new FunctionQuery(
-            new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2)),
+        new ByteVectorSimilarityFunction(VectorSimilarityFunction.EUCLIDEAN, v1, v2),
         new float[] {0.5f, 0.f});
   }
 
@@ -259,6 +252,12 @@ public void vectorSimilarity_wrongFieldType_shouldRaiseException() {
         () -> searcher.search(new FunctionQuery(idVectorSimilarityFunction), 10));
   }
 
+  private static void assertHits(final ValueSource func, final float[] scores) throws Exception {
+    assertHits(new FunctionQuery(func), scores);
+    assertHits(
+        new FunctionScoreQuery(new MatchAllDocsQuery(), func.asDoubleValuesSource()), scores);
+  }
+
   private static void assertHits(Query q, float[] scores) throws Exception {
     ScoreDoc[] expected = new ScoreDoc[scores.length];
     int[] expectedDocs = new int[scores.length];