Returns an Explanation that describes how
CopyC#
doc
 scored against
CopyC#
query
.

This is intended to be used in developing Similarity implementations, and, for good performance, should not be displayed with every hit. Computing an explanation is as expensive as executing the query over the entire index.

Namespace: Lucene.Net.Search
Assembly: Lucene.Net (in Lucene.Net.dll) Version: 2.9.4.1

Syntax

C#
public virtual Explanation Explain(
	Query query,
	int doc
)
Visual Basic
Public Overridable Function Explain ( _
	query As Query, _
	doc As Integer _
) As Explanation
Visual C++
public:
virtual Explanation^ Explain(
	Query^ query, 
	int doc
)

Parameters

query
Type: Lucene.Net.Search..::..Query

[Missing <param name="query"/> documentation for "M:Lucene.Net.Search.Searcher.Explain(Lucene.Net.Search.Query,System.Int32)"]

doc
Type: System..::..Int32

[Missing <param name="doc"/> documentation for "M:Lucene.Net.Search.Searcher.Explain(Lucene.Net.Search.Query,System.Int32)"]

Return Value

[Missing <returns> documentation for "M:Lucene.Net.Search.Searcher.Explain(Lucene.Net.Search.Query,System.Int32)"]

See Also