Computes a score factor for a simple term and returns an explanation for that score factor.

The default implementation uses:

            idf(searcher.docFreq(term), searcher.maxDoc());
            
Note that {@link Searcher#MaxDoc()} is used instead of {@link Lucene.Net.Index.IndexReader#NumDocs()} because it is proportional to {@link Searcher#DocFreq(Term)} , i.e., when one is inaccurate, so is the other, and in the same direction.

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

Syntax

C#
public virtual Explanation..::..IDFExplanation IdfExplain(
	Term term,
	Searcher searcher
)
Visual Basic
Public Overridable Function IdfExplain ( _
	term As Term, _
	searcher As Searcher _
) As Explanation..::..IDFExplanation
Visual C++
public:
virtual Explanation..::..IDFExplanation^ IdfExplain(
	Term^ term, 
	Searcher^ searcher
)

Parameters

term
Type: Lucene.Net.Index..::..Term
the term in question
searcher
Type: Lucene.Net.Search..::..Searcher
the document collection being searched

Return Value

an IDFExplain object that includes both an idf score factor and an explanation for the term.

See Also