jtibshirani commented on a change in pull request #656:
URL: https://github.com/apache/lucene/pull/656#discussion_r807399758
##########
File path: lucene/core/src/java/org/apache/lucene/codecs/KnnVectorsReader.java
##########
@@ -58,6 +60,12 @@ protected KnnVectorsReader() {}
* true k closest neighbors. For large values of k (for example when k is
close to the total
* number of documents), the search may also retrieve fewer than k documents.
*
+ * <p>The returned {@link TopDocs} will contain a {@link ScoreDoc} for each
nearest neighbor, in
+ * order of their similarity to the query vector (decreasing scores). The
{@link TotalHits}
+ * contains the number of documents visited during the search. If the search
stopped early because
+ * it hit {@code visitedLimit}, it is indicated through the relation {@code
Review comment:
It's possible (but unlikely) that the search completed normally with
exactly `numVisited == visitedLimit`. The `visitedLimit` is inclusive. To me it
felt more solid and obvious to use the relation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
