Add clarification to javadoc

marianotepper · marianotepper · commit 27b6b2a5bfdb · 2025-11-19T06:35:57.000-08:00
diff --git a/jvector-base/src/main/java/io/github/jbellis/jvector/quantization/PQVectors.java b/jvector-base/src/main/java/io/github/jbellis/jvector/quantization/PQVectors.java
@@ -112,7 +112,7 @@ public static ImmutablePQVectors encodeAndBuild(ProductQuantization pq, int[] or
      *
      * @param pq           the ProductQuantization to use
      * @param vectorCount  the number of vectors to encode
-     * @param ordinalsMapping the graph ordinals to RAVV mapping
+     * @param ordinalsMapping the graph ordinals to RAVV mapping, the function should be defined in [0, vectorCount)
      * @param ravv         the RandomAccessVectorValues to encode
      * @param simdExecutor the ForkJoinPool to use for SIMD operations
      * @return the PQVectors instance

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public static ImmutablePQVectors encodeAndBuild(ProductQuantization pq, int[] or`
`112`	`112`	`*`
`113`	`113`	`* @param pq the ProductQuantization to use`
`114`	`114`	`* @param vectorCount the number of vectors to encode`
`115`		`- * @param ordinalsMapping the graph ordinals to RAVV mapping`
	`115`	`+ * @param ordinalsMapping the graph ordinals to RAVV mapping, the function should be defined in [0, vectorCount)`
`116`	`116`	`* @param ravv the RandomAccessVectorValues to encode`
`117`	`117`	`* @param simdExecutor the ForkJoinPool to use for SIMD operations`
`118`	`118`	`* @return the PQVectors instance`