Skip to content

Apache Lucene open-source search software

Change TopGroups.merge() to accept a list of TopGroups (#15897)

gaobinlong282b4d29ddd7
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 5fcc0877813..aa725cf5d8a 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -75,6 +75,8 @@ API Changes
* GITHUB#15295 : Switched to a fixed CFS threshold (Shubham Sharma)
+* GITHUB#15486: Change TopGroups.merge() to accept a list of TopGroups (Binlong Gao)
+
* GITHUB#15627 : Deferred lambda in TermStates.java according to prefetch (Shubham Sharma)
* GITHUB#15939: Removed RegexpQuery constructor overloads that exposed determinization controls
diff --git a/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroups.java b/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroups.java
index 5568be3a849..163a722ae8d 100644
--- a/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroups.java
+++ b/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroups.java
@@ -16,6 +16,7 @@
*/
package org.apache.lucene.search.grouping;
+import java.util.List;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.Sort;
import org.apache.lucene.search.SortField;
@@ -102,9 +103,9 @@ public class TopGroups<T> {
}
/**
- * Merges an array of TopGroups, for example obtained from the second-pass collector across
- * multiple shards. Each TopGroups must have been sorted by the same groupSort and docSort, and
- * the top groups passed to all second-pass collectors must be the same.
+ * Merges a list of TopGroups, for example obtained from the second-pass collector across multiple
+ * shards. Each TopGroups must have been sorted by the same groupSort and docSort, and the top
+ * groups passed to all second-pass collectors must be the same.
*
* <p><b>NOTE</b>: We can't always compute an exact totalGroupCount. Documents belonging to a
* group may occur on more than one shard and thus the merged totalGroupCount can be higher than
@@ -114,7 +115,7 @@ public class TopGroups<T> {
* <p><b>NOTE</b>: the topDocs in each GroupDocs is actually an instance of TopDocsAndShards
*/
public static <T> TopGroups<T> merge(
- TopGroups<T>[] shardGroups,
+ List<TopGroups<T>> shardGroups,
Sort groupSort,
Sort docSort,
int docOffset,
@@ -123,7 +124,7 @@ public class TopGroups<T> {
// System.out.println("TopGroups.merge");
- if (shardGroups.length == 0) {
+ if (shardGroups.isEmpty()) {
return null;
}
@@ -132,7 +133,9 @@ public class TopGroups<T> {
// Optionally merge the totalGroupCount.
Integer totalGroupCount = null;
- final int numGroups = shardGroups[0].groups.length;
+ TopGroups<T> firstShardGroup = shardGroups.getFirst();
+
+ final int numGroups = firstShardGroup.groups.length;
for (TopGroups<T> shard : shardGroups) {
if (numGroups != shard.groups.length) {
throw new IllegalArgumentException(
@@ -154,22 +157,22 @@ public class TopGroups<T> {
final TopDocs[] shardTopDocs;
if (docSort.equals(Sort.RELEVANCE)) {
- shardTopDocs = new TopDocs[shardGroups.length];
+ shardTopDocs = new TopDocs[shardGroups.size()];
} else {
- shardTopDocs = new TopFieldDocs[shardGroups.length];
+ shardTopDocs = new TopFieldDocs[shardGroups.size()];
}
float totalMaxScore = Float.NaN;
for (int groupIDX = 0; groupIDX < numGroups; groupIDX++) {
- final T groupValue = shardGroups[0].groups[groupIDX].groupValue();
+ final T groupValue = firstShardGroup.groups[groupIDX].groupValue();
// System.out.println(" merge groupValue=" + groupValue + " sortValues=" +
// Arrays.toString(shardGroups[0].groups[groupIDX].groupSortValues));
float maxScore = Float.NaN;
int totalHits = 0;
double scoreSum = 0.0;
- for (int shardIDX = 0; shardIDX < shardGroups.length; shardIDX++) {
+ for (int shardIDX = 0; shardIDX < shardGroups.size(); shardIDX++) {
// System.out.println(" shard=" + shardIDX);
- final TopGroups<T> shard = shardGroups[shardIDX];
+ final TopGroups<T> shard = shardGroups.get(shardIDX);
final GroupDocs<?> shardGroupDocs = shard.groups[groupIDX];
if (groupValue == null) {
if (shardGroupDocs.groupValue() != null) {
@@ -256,7 +259,7 @@ public class TopGroups<T> {
new TotalHits(totalHits, TotalHits.Relation.EQUAL_TO),
mergedScoreDocs,
groupValue,
- shardGroups[0].groups[groupIDX].groupSortValues());
+ firstShardGroup.groups[groupIDX].groupSortValues());
totalMaxScore = nonNANmax(totalMaxScore, maxScore);
}
diff --git a/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroupsCollectorManager.java b/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroupsCollectorManager.java
index 200e61e434a..74210871921 100644
--- a/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroupsCollectorManager.java
+++ b/lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroupsCollectorManager.java
@@ -130,10 +130,8 @@ public class TopGroupsCollectorManager<T>
return null;
}
- @SuppressWarnings({"unchecked", "rawtypes"})
- TopGroups<T>[] shardGroups = (TopGroups<T>[]) shardGroupsList.toArray(TopGroups[]::new);
return TopGroups.merge(
- shardGroups, groupSort, sortWithinGroup, 0, maxDocsPerGroup, scoreMergeMode);
+ shardGroupsList, groupSort, sortWithinGroup, 0, maxDocsPerGroup, scoreMergeMode);
}
public List<TopGroupsCollector<T>> getCollectors() {
diff --git a/lucene/grouping/src/test/org/apache/lucene/search/grouping/BaseGroupSelectorTestCase.java b/lucene/grouping/src/test/org/apache/lucene/search/grouping/BaseGroupSelectorTestCase.java
index f17cbdc8b85..d936822cb6e 100644
--- a/lucene/grouping/src/test/org/apache/lucene/search/grouping/BaseGroupSelectorTestCase.java
+++ b/lucene/grouping/src/test/org/apache/lucene/search/grouping/BaseGroupSelectorTestCase.java
@@ -330,16 +330,12 @@ public abstract class BaseGroupSelectorTestCase<T> extends AbstractGroupingTestC
TopGroups<T> singletonTopGroups =
control.getIndexSearcher().search(topLevel, topGroupsCollectorManager);
- // TODO why does SearchGroup.merge() take a list but TopGroups.merge() take an array?
- @SuppressWarnings("unchecked")
- TopGroups<T>[] shardTopGroups = (TopGroups<T>[]) new TopGroups<?>[shards.length];
- int j = 0;
+ List<TopGroups<T>> shardTopGroups = new ArrayList<>(shards.length);
for (Shard shard : shards) {
TopGroupsCollectorManager<T> scm =
new TopGroupsCollectorManager<>(
this::getGroupSelector, mergedGroups, sort, Sort.RELEVANCE, 5, true);
- shardTopGroups[j] = shard.getIndexSearcher().search(topLevel, scm);
- j++;
+ shardTopGroups.add(shard.getIndexSearcher().search(topLevel, scm));
}
TopGroups<T> mergedTopGroups =
TopGroups.merge(shardTopGroups, sort, Sort.RELEVANCE, 0, 5, TopGroups.ScoreMergeMode.None);
diff --git a/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestGrouping.java b/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestGrouping.java
index 37ee890fbf1..c191966a031 100644
--- a/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestGrouping.java
+++ b/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestGrouping.java
@@ -1528,8 +1528,7 @@ public class TestGrouping extends LuceneTestCase {
if (mergedTopGroups != null) {
// Now 2nd pass:
- @SuppressWarnings({"unchecked", "rawtypes"})
- final TopGroups<BytesRef>[] shardTopGroups = new TopGroups[subSearchers.length];
+ final List<TopGroups<BytesRef>> shardTopGroups = new ArrayList<>(subSearchers.length);
for (int shardIDX = 0; shardIDX < subSearchers.length; shardIDX++) {
final TopGroupsCollector<?> secondPassCollector =
createSecondPassCollector(
@@ -1541,11 +1540,15 @@ public class TestGrouping extends LuceneTestCase {
docOffset + topNDocs,
getMaxScores);
subSearchers[shardIDX].search(w, secondPassCollector);
- shardTopGroups[shardIDX] = getTopGroups(secondPassCollector, 0);
+ shardTopGroups.add(getTopGroups(secondPassCollector, 0));
if (VERBOSE) {
System.out.println(
- " " + shardTopGroups[shardIDX].groups.length + " shard[" + shardIDX + "] groups:");
- for (GroupDocs<BytesRef> group : shardTopGroups[shardIDX].groups) {
+ " "
+ + shardTopGroups.get(shardIDX).groups.length
+ + " shard["
+ + shardIDX
+ + "] groups:");
+ for (GroupDocs<BytesRef> group : shardTopGroups.get(shardIDX).groups) {
System.out.println(
" ["
+ groupToString(group.groupValue())
diff --git a/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestTopGroups.java b/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestTopGroups.java
index ab64227ee22..39a1ad6b5d0 100644
--- a/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestTopGroups.java
+++ b/lucene/grouping/src/test/org/apache/lucene/search/grouping/TestTopGroups.java
@@ -16,6 +16,7 @@
*/
package org.apache.lucene.search.grouping;
+import java.util.List;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.Sort;
import org.apache.lucene.search.TotalHits;
@@ -172,7 +173,7 @@ public class TestTopGroups extends LuceneTestCase {
final TopGroups<String> mergedTopGroups =
TopGroups.<String>merge(
- combineTopGroups(shard1TopGroups, shard2TopGroups),
+ List.of(shard1TopGroups, shard2TopGroups),
sort /* groupSort */,
sort /* docSort */,
0 /* docOffset */,
@@ -254,13 +255,4 @@ public class TestTopGroups extends LuceneTestCase {
groups[1] = group1;
return groups;
}
-
- private static TopGroups<String>[] combineTopGroups(
- TopGroups<String> group0, TopGroups<String> group1) {
- @SuppressWarnings({"unchecked", "rawtypes"})
- final TopGroups<String>[] groups = new TopGroups[2];
- groups[0] = group0;
- groups[1] = group1;
- return groups;
- }
}