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
System.Object
BasicModel
BasicModelBE
BasicModelD
BasicModelG
BasicModelIF
BasicModelIn
BasicModelIne
BasicModelP
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Search.Similarities
Assembly: Lucene.Net.dll
Syntax
public abstract class BasicModel

Constructors

| Improve this Doc View Source

BasicModel()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration
protected BasicModel()

Methods

| Improve this Doc View Source

Explain(BasicStats, Single)

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
System.Single tfn
Returns
Type Description
Explanation
| Improve this Doc View Source

Score(BasicStats, Single)

Returns the informative content score.

Declaration
public abstract float Score(BasicStats stats, float tfn)
Parameters
Type Name Description
BasicStats stats
System.Single tfn
Returns
Type Description
System.Single
| Improve this Doc View Source

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 abstract override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

See Also