Explain the custom score. Whenever overriding {@link #customScore(int, float, float[])}, this method should also be overridden to provide the correct explanation for the part of the custom scoring.

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

Syntax

C#
public virtual Explanation CustomExplain(
	int doc,
	Explanation subQueryExpl,
	Explanation[] valSrcExpls
)
Visual Basic
Public Overridable Function CustomExplain ( _
	doc As Integer, _
	subQueryExpl As Explanation, _
	valSrcExpls As Explanation() _
) As Explanation
Visual C++
public:
virtual Explanation^ CustomExplain(
	int doc, 
	Explanation^ subQueryExpl, 
	array<Explanation^>^ valSrcExpls
)

Parameters

doc
Type: System..::..Int32
doc being explained
subQueryExpl
Type: Lucene.Net.Search..::..Explanation
explanation for the sub-query part
valSrcExpls
Type: array<Lucene.Net.Search..::..Explanation>[]()[][]
explanation for the value source part

Return Value

an explanation for the custom score

See Also