Table of Contents

Public classSealed TopDocs

Namespace
Rowles.LeanCorpus.Search.Scoring
Assembly
Rowles.LeanCorpus.dll

Encapsulates the results of a search query.

public sealed class TopDocs
TopDocs

Public constructor TopDocs(int, ScoreDoc[])

Initialises a new TopDocs with the given total hit count and scored results.

Public constructor TopDocs(int, ScoreDoc[], bool)

Initialises a new TopDocs with the given total hit count, scored results, and partial-result indicator.

Public property Empty

Gets an empty TopDocs with zero hits.

Public property IsPartial

Gets a value indicating whether the search terminated before all segments were scored, due to a SearchOptions.Timeout deadline or cancellation. When true, ScoreDocs and TotalHits reflect only the work completed before termination.

Public property ScoreDocs

Gets the array of scored documents in descending score order.

Public property TotalHits

Gets the total number of documents that matched the query (may be larger than ScoreDocs).

Internal methodInternal AsPartial()

Returns a copy of this TopDocs with IsPartial set to true.

Edit this page