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
System.Object
Normalization
Normalization.NoNormalization
NormalizationH1
NormalizationH2
NormalizationH3
NormalizationZ
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 Normalization

Constructors

| Improve this Doc View Source

Normalization()

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

Declaration
protected Normalization()

Methods

| Improve this Doc View Source

Explain(BasicStats, Single, Single)

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

Tfn(BasicStats, Single, Single)

Returns the normalized term frequency.

Declaration
public abstract float Tfn(BasicStats stats, float tf, float len)
Parameters
Type Name Description
BasicStats stats
System.Single tf
System.Single len

the field length.

Returns
Type Description
System.Single
| Improve this Doc View Source

ToString()

Subclasses must override this method to return the code of the normalization 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