Class TopGroups

LUCENENET specific class used to nest types to mimic the syntax used by Lucene (that is, without specifying the generic closing type of TopGroups<TGroupValue>)

Inheritance

object

TopGroups

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Search.Grouping

Assembly: Lucene.Net.Grouping.dll

Syntax

public static class TopGroups

Methods

Merge<T>(ITopGroups<T>[], Sort, Sort, int, int, ScoreMergeMode)

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.

NOTE: 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 the actual totalGroupCount. In this case the totalGroupCount represents a upper bound. If the documents of one group do only reside in one shard then the totalGroupCount is exact.

NOTE: the topDocs in each GroupDocs is actually an instance of TopDocsAndShards

Declaration

public static TopGroups<T> Merge<T>(ITopGroups<T>[] shardGroups, Sort groupSort, Sort docSort, int docOffset, int docTopN, TopGroups.ScoreMergeMode scoreMergeMode)

Parameters

Type	Name	Description
ITopGroups<T>[]	shardGroups
Sort	groupSort
Sort	docSort
int	docOffset
int	docTopN
TopGroups.ScoreMergeMode	scoreMergeMode

Returns

Type	Description
TopGroups<T>

Type Parameters

Name	Description
T