jpountz commented on code in PR #12434: URL: https://github.com/apache/lucene/pull/12434#discussion_r1274552571
########## lucene/core/src/java/org/apache/lucene/search/KnnResults.java: ########## @@ -0,0 +1,88 @@ +/* + * 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.search; + +/** + * KnnResults is a collector for gathering kNN results and providing topDocs from the gathered + * neighbors + */ +public abstract class KnnResults { + + protected int visitedCount; + private final int visitLimit; + private final int k; + + protected KnnResults(int k, int visitLimit) { + this.visitLimit = visitLimit; + this.k = k; + } + + /** + * @return is the current result set marked as incomplete? + */ + public final boolean incomplete() { + return visitedCount >= visitLimit; + } + + public final void incVisitedCount(int count) { + assert count > 0; + this.visitedCount += count; + } + + /** + * @return the current visited count + */ + public final int visitedCount() { + return visitedCount; + } + + public final int visitLimit() { + return visitLimit; + } + + public final int k() { Review Comment: I wonder if we can avoid adding it to the public API, the search logic doesn't need to know how many hits are being searched? ########## lucene/core/src/java/org/apache/lucene/search/KnnResults.java: ########## @@ -0,0 +1,88 @@ +/* + * 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.search; + +/** + * KnnResults is a collector for gathering kNN results and providing topDocs from the gathered + * neighbors + */ +public abstract class KnnResults { + + protected int visitedCount; + private final int visitLimit; Review Comment: Thinking out loud: maybe we should make these two quantities `long`s instead of `int`s so that we don't have to break it when introducing multi-value support. ########## lucene/core/src/java/org/apache/lucene/search/KnnResults.java: ########## @@ -0,0 +1,88 @@ +/* + * 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.search; + +/** + * KnnResults is a collector for gathering kNN results and providing topDocs from the gathered + * neighbors + */ +public abstract class KnnResults { + + protected int visitedCount; + private final int visitLimit; + private final int k; + + protected KnnResults(int k, int visitLimit) { + this.visitLimit = visitLimit; + this.k = k; + } + + /** + * @return is the current result set marked as incomplete? + */ + public final boolean incomplete() { + return visitedCount >= visitLimit; + } + + public final void incVisitedCount(int count) { + assert count > 0; + this.visitedCount += count; + } + + /** + * @return the current visited count + */ + public final int visitedCount() { + return visitedCount; + } + + public final int visitLimit() { + return visitLimit; + } + + public final int k() { + return k; + } + + /** + * Collect the provided docId and include in the result set. + * + * @param docId of the vector to collect + * @param similarity its calculated similarity + * @return true if the vector is collected + */ + public abstract boolean collect(int docId, float similarity); + + /** + * @return Is the current result set considered full + */ + public abstract boolean isFull(); + + /** + * @return the current minimum similarity in the collection + */ + public abstract float minSimilarity(); Review Comment: Related to the discussion about `isFull()`, maybe a better name would be `minCompetitiveSimilarity` (akin to `Scorable#setMinCompetitiveScore`) to better convey that this is used for filtering rather than a getter of the similarity of the top entry of the queue. ########## lucene/core/src/java/org/apache/lucene/search/KnnResults.java: ########## @@ -0,0 +1,88 @@ +/* + * 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.search; + +/** + * KnnResults is a collector for gathering kNN results and providing topDocs from the gathered + * neighbors + */ +public abstract class KnnResults { + + protected int visitedCount; + private final int visitLimit; + private final int k; + + protected KnnResults(int k, int visitLimit) { + this.visitLimit = visitLimit; + this.k = k; + } + + /** + * @return is the current result set marked as incomplete? + */ + public final boolean incomplete() { Review Comment: Thinking out loud, I wonder if `exhausted` would be a better name as NN results would be incomplete by nature due to the approximate nature of most algorithms. -- 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
