Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Properties | List of all members
Lucene.Net.Search.Explanation.IDFExplanation Class Referenceabstract

Small Util class used to pass both an idf factor as well as an explanation for that factor. More...

Public Member Functions

abstract System.String Explain ()
 This should be calculated lazily if possible.
 

Properties

abstract float Idf [get]
 the idf factor
 

Detailed Description

Small Util class used to pass both an idf factor as well as an explanation for that factor.

This class will likely be held on a Weight, so be aware before storing any large or un-serializable fields.

Definition at line 155 of file Explanation.cs.

Member Function Documentation

abstract System.String Lucene.Net.Search.Explanation.IDFExplanation.Explain ( )
pure virtual

This should be calculated lazily if possible.

Returns
the explanation for the idf factor.

Property Documentation

abstract float Lucene.Net.Search.Explanation.IDFExplanation.Idf
get

the idf factor

Definition at line 158 of file Explanation.cs.


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