Class Normalization
This class acts as the base class for the implementations of the term frequency normalization methods in the DFR framework.
Note
This API is experimental and might change in incompatible ways in the next release.
Inheritance
Inherited Members
Namespace: Lucene.Net.Search.Similarities
Assembly: Lucene.Net.dll
Syntax
public abstract class NormalizationConstructors
Normalization()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Declaration
protected Normalization()See Also
Methods
Explain(BasicStats, float, float)
Returns an explanation for the normalized term frequency.
The default normalization methods use the field length of the document and the average field length to compute the normalized term frequency. This method provides a generic explanation for such methods. Subclasses that use other statistics must override this method.
Declaration
public virtual Explanation Explain(BasicStats stats, float tf, float len)Parameters
| Type | Name | Description |
|---|---|---|
| BasicStats | stats | |
| float | tf | |
| float | len |
Returns
| Type | Description |
|---|---|
| Explanation |
See Also
Tfn(BasicStats, float, float)
Returns the normalized term frequency.
Declaration
public abstract float Tfn(BasicStats stats, float tf, float len)Parameters
| Type | Name | Description |
|---|---|---|
| BasicStats | stats | |
| float | tf | |
| float | len | the field length. |
Returns
| Type | Description |
|---|---|
| float |
See Also
ToString()
Subclasses must override this method to return the code of the normalization formula. Refer to the original paper for the list.
Declaration
public override abstract string ToString()Returns
| Type | Description |
|---|---|
| string |