From 0d6f6f103a4d596e12fc7a653233bad4a11b5c3b Mon Sep 17 00:00:00 2001
From: Vigya Sharma <vigya.work@gmail.com>
Date: Tue, 12 Nov 2024 16:16:54 -0800
Subject: [PATCH] javadocs

---
 .../lucene/index/MultiVectorSimilarityFunction.java  | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/lucene/core/src/java/org/apache/lucene/index/MultiVectorSimilarityFunction.java b/lucene/core/src/java/org/apache/lucene/index/MultiVectorSimilarityFunction.java
index b6184bd77d9..8ed0e8bc500 100644
--- a/lucene/core/src/java/org/apache/lucene/index/MultiVectorSimilarityFunction.java
+++ b/lucene/core/src/java/org/apache/lucene/index/MultiVectorSimilarityFunction.java
@@ -155,10 +155,22 @@ public class MultiVectorSimilarityFunction {
     this.aggregation = aggregation;
   }
 
+  /**
+   * Compute similarity between two float multi-vectors.
+   *
+   * <p>Expects all component vector values as a single packed float[] for each multi-vector. Uses
+   * configured aggregation function and vector similarity.
+   */
   public float compare(float[] t1, float[] t2, int dimension) {
     return aggregation.aggregate(t1, t2, similarityFunction, dimension);
   }
 
+  /**
+   * Compute similarity between two byte multi-vectors.
+   *
+   * <p>Expects all component vector values as a single packed float[] for each multi-vector. Uses
+   * configured aggregation function and vector similarity.
+   */
   public float compare(byte[] t1, byte[] t2, int dimension) {
     return aggregation.aggregate(t1, t2, similarityFunction, dimension);
   }