## Uses of Class
org.apache.lucene.search.TopDocs

Packages that use TopDocs
org.apache.lucene.search: Code to search indices.

### Uses of TopDocs in org.apache.lucene.search

Subclasses of TopDocs in org.apache.lucene.search
`class` `TopFieldDocs` Represents hits returned by `IndexSearcher.search(Query,int,Sort)`.

Fields in org.apache.lucene.search declared as TopDocs
`protected static TopDocs` TopDocsCollector.`EMPTY_TOPDOCS` This is used in case topDocs() is called with illegal parameters, or there simply aren't (enough) results.

Methods in org.apache.lucene.search that return TopDocs
`static TopDocs` TopDocs.`merge(int start, int topN, TopDocs[] shardHits, boolean setShardIndex)` Same as `merge(int, TopDocs[])` but also ignores the top `start` top docs.
`static TopDocs` TopDocs.`merge(int topN, TopDocs[] shardHits)` Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.
`protected TopDocs` TopScoreDocCollector.`newTopDocs(ScoreDoc[] results, int start)`
`protected TopDocs` TopFieldCollector.`newTopDocs(ScoreDoc[] results, int start)`
`protected TopDocs` TopDocsCollector.`newTopDocs(ScoreDoc[] results, int start)` Returns a `TopDocs` instance containing the given results.
`TopDocs` QueryRescorer.`rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)`
`abstract TopDocs` Rescorer.`rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)` Rescore an initial first-pass `TopDocs`.
`TopDocs` SortRescorer.`rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)`
`static TopDocs` QueryRescorer.`rescore(IndexSearcher searcher, TopDocs topDocs, Query query, double weight, int topN)` Sugar API, calling {#rescore} using a simple linear combination of firstPassScore + weight * secondPassScore
`TopDocs` IndexSearcher.`search(Query query, int n)` Finds the top `n` hits for `query`.
`TopDocs` IndexSearcher.`searchAfter(ScoreDoc after, Query query, int numHits)` Finds the top `n` hits for `query` where all results are after a previous result (`after`).
`TopDocs` IndexSearcher.`searchAfter(ScoreDoc after, Query query, int n, Sort sort)` Finds the top `n` hits for `query` where all results are after a previous result (`after`).
`TopDocs` TopDocsCollector.`topDocs()` Returns the top docs that were collected by this collector.
`TopDocs` TopDocsCollector.`topDocs(int start)` Returns the documents in the range [start ..
`TopDocs` TopDocsCollector.`topDocs(int start, int howMany)` Returns the documents in the range [start ..

Methods in org.apache.lucene.search that return types with arguments of type TopDocs
`static CollectorManager<TopScoreDocCollector,TopDocs>` TopScoreDocCollector.`createSharedManager(int numHits, FieldDoc after, int totalHitsThreshold)` Create a CollectorManager which uses a shared hit counter to maintain number of hits and a shared `MaxScoreAccumulator` to propagate the minimum score accross segments

Methods in org.apache.lucene.search with parameters of type TopDocs
`static TopDocs` TopDocs.`merge(int start, int topN, TopDocs[] shardHits, boolean setShardIndex)` Same as `merge(int, TopDocs[])` but also ignores the top `start` top docs.
`static TopDocs` TopDocs.`merge(int topN, TopDocs[] shardHits)` Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.
`TopDocs` QueryRescorer.`rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)`
`abstract TopDocs` Rescorer.`rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)` Rescore an initial first-pass `TopDocs`.
`TopDocs` SortRescorer.`rescore(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN)`
`static TopDocs` QueryRescorer.`rescore(IndexSearcher searcher, TopDocs topDocs, Query query, double weight, int topN)` Sugar API, calling {#rescore} using a simple linear combination of firstPassScore + weight * secondPassScore