Lucene.Net.Search.TopDocs Class Reference

Represents hits returned by Searcher.Search(Query,Filter,int) and Searcher.Search(Query,int) More...

Inherited by Lucene.Net.Search.TopFieldDocs.

Public Member Functions
	TopDocs (int totalHits, ScoreDoc[] scoreDocs, float maxScore)

Properties
int	TotalHits [get, set]
	The total number of hits for the query.
ScoreDoc[]	ScoreDocs [get, set]
	The top hits for the query.
float	MaxScore [get, set]
	Gets or sets the maximum score value encountered, needed for normalizing. Note that in case scores are not tracked, this returns float.NaN.

Detailed Description

Represents hits returned by Searcher.Search(Query,Filter,int) and Searcher.Search(Query,int)

Definition at line 27 of file TopDocs.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.TopDocs.TopDocs	(	int	totalHits,
		ScoreDoc[]	scoreDocs,
		float	maxScore
	)

Definition at line 64 of file TopDocs.cs.

Property Documentation

float Lucene.Net.Search.TopDocs.MaxScore

getset

Gets or sets the maximum score value encountered, needed for normalizing. Note that in case scores are not tracked, this returns float.NaN.

Definition at line 53 of file TopDocs.cs.

ScoreDoc [] Lucene.Net.Search.TopDocs.ScoreDocs

getset

The top hits for the query.

Definition at line 43 of file TopDocs.cs.

int Lucene.Net.Search.TopDocs.TotalHits

getset

The total number of hits for the query.

Definition at line 35 of file TopDocs.cs.

---

The documentation for this class was generated from the following file:

• core/Search/TopDocs.cs