Class NormalizationH1
- java.lang.Object
-
- org.apache.lucene.search.similarities.Normalization
-
- org.apache.lucene.search.similarities.NormalizationH1
-
public class NormalizationH1 extends Normalization
Normalization model that assumes a uniform distribution of the term frequency.While this model is parameterless in the original article, information-based models (see
IBSimilarity
) introduced a multiplying factor. The default value for thec
parameter is1
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.similarities.Normalization
Normalization.NoNormalization
-
-
Constructor Summary
Constructors Constructor Description NormalizationH1()
CallsNormalizationH1(1)
NormalizationH1(float c)
Creates NormalizationH1 with the supplied parameterc
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description float
getC()
Returns thec
parameter.float
tfn(BasicStats stats, float tf, float len)
Returns the normalized term frequency.java.lang.String
toString()
Subclasses must override this method to return the code of the normalization formula.-
Methods inherited from class org.apache.lucene.search.similarities.Normalization
explain
-
-
-
-
Constructor Detail
-
NormalizationH1
public NormalizationH1(float c)
Creates NormalizationH1 with the supplied parameterc
.- Parameters:
c
- hyper-parameter that controls the term frequency normalization with respect to the document length.
-
NormalizationH1
public NormalizationH1()
CallsNormalizationH1(1)
-
-
Method Detail
-
tfn
public final float tfn(BasicStats stats, float tf, float len)
Description copied from class:Normalization
Returns the normalized term frequency.- Specified by:
tfn
in classNormalization
len
- the field length.
-
toString
public java.lang.String toString()
Description copied from class:Normalization
Subclasses must override this method to return the code of the normalization formula. Refer to the original paper for the list.- Specified by:
toString
in classNormalization
-
getC
public float getC()
Returns thec
parameter.- See Also:
NormalizationH1(float)
-
-