benwtrent commented on code in PR #12434: URL: https://github.com/apache/lucene/pull/12434#discussion_r1272680226
########## lucene/core/src/java/org/apache/lucene/util/hnsw/KnnResults.java: ########## @@ -0,0 +1,136 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.lucene.util.hnsw; + +import org.apache.lucene.search.ScoreDoc; +import org.apache.lucene.search.TopDocs; +import org.apache.lucene.search.TotalHits; + +/** + * KnnResults is a collector for gathering kNN results and providing topDocs from the gathered + * neighbors + */ +public abstract class KnnResults { + + /** KnnResults when exiting search early and returning empty top docs */ + static class EmptyKnnResults extends KnnResults { + public EmptyKnnResults(int visitedCount) { + this.visitedCount = visitedCount; + } + + @Override + public void doClear() {} + + @Override + public void collect(int vectorId, float similarity) { + throw new IllegalArgumentException(); + } + + @Override + public boolean collectWithOverflow(int vectorId, float similarity) { + return false; + } + + @Override + public boolean isFull() { + return true; + } + + @Override + public float minSimilarity() { + return 0; + } + + @Override + public TopDocs topDocs() { + TotalHits th = new TotalHits(visitedCount, TotalHits.Relation.GREATER_THAN_OR_EQUAL_TO); + return new TopDocs(th, new ScoreDoc[0]); + } + } + + protected int visitedCount; + private boolean incomplete; + + final void clear() { + this.visitedCount = 0; + this.incomplete = false; + doClear(); + } + + /** Clear the current results. */ + abstract void doClear(); + + /** + * @return is the current result set marked as incomplete? + */ + final boolean incomplete() { + return incomplete; + } + + /** Mark the current result set as incomplete */ + final void markIncomplete() { + this.incomplete = true; + } + + /** + * @param count set the current visited count to the provided value + */ + final void setVisitedCount(int count) { + this.visitedCount = count; + } + + /** + * @return the current visited count + */ + final int visitedCount() { + return visitedCount; + } + + /** + * Collect the provided vectorId and include in the result set. + * + * @param vectorId the vector to collect + * @param similarity its calculated similarity + */ + abstract void collect(int vectorId, float similarity); + + /** + * @param vectorId the vector to collect + * @param similarity its calculated similarity + * @return true if the vector is collected + */ + abstract boolean collectWithOverflow(int vectorId, float similarity); Review Comment: Latest commit makes this change. -- 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
