Class BasicModel
This class acts as the base class for the specific basic model implementations in the DFR framework. Basic models compute the informative content Inf1 = -log2Prob1.
Note
This API is experimental and might change in incompatible ways in the next release.
Inheritance
BasicModel
Inherited Members
Namespace: Lucene.Net.Search.Similarities
Assembly: Lucene.Net.dll
Syntax
public abstract class BasicModelConstructors
BasicModel()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Declaration
protected BasicModel()See Also
Methods
Explain(BasicStats, float)
Returns an explanation for the score.
Most basic models use the number of documents and the total term frequency to compute Inf1. this method provides a generic explanation for such models. Subclasses that use other statistics must override this method.
Declaration
public virtual Explanation Explain(BasicStats stats, float tfn)Parameters
| Type | Name | Description |
|---|---|---|
| BasicStats | stats | |
| float | tfn |
Returns
| Type | Description |
|---|---|
| Explanation |
See Also
Score(BasicStats, float)
Returns the informative content score.
Declaration
public abstract float Score(BasicStats stats, float tfn)Parameters
| Type | Name | Description |
|---|---|---|
| BasicStats | stats | |
| float | tfn |
Returns
| Type | Description |
|---|---|
| float |
See Also
ToString()
Subclasses must override this method to return the code of the basic model formula. Refer to the original paper for the list.
Declaration
public override abstract string ToString()Returns
| Type | Description |
|---|---|
| string |