Class NormalizationH2
- java.lang.Object
-
- org.apache.lucene.search.similarities.Normalization
-
- org.apache.lucene.search.similarities.NormalizationH2
-
public class NormalizationH2 extends Normalization
Normalization model in which the term frequency is inversely related to the length.While this model is parameterless in the original article, the thesis introduces the parameterized variant. The default value for the
cparameter is1.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.similarities.Normalization
Normalization.NoNormalization
-
-
Constructor Summary
Constructors Constructor Description NormalizationH2()CallsNormalizationH2(1)NormalizationH2(float c)Creates NormalizationH2 with the supplied parameterc.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description floatgetC()Returns thecparameter.floattfn(BasicStats stats, float tf, float len)Returns the normalized term frequency.java.lang.StringtoString()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
-
NormalizationH2
public NormalizationH2(float c)
Creates NormalizationH2 with the supplied parameterc.- Parameters:
c- hyper-parameter that controls the term frequency normalization with respect to the document length.
-
NormalizationH2
public NormalizationH2()
CallsNormalizationH2(1)
-
-
Method Detail
-
tfn
public final float tfn(BasicStats stats, float tf, float len)
Description copied from class:NormalizationReturns the normalized term frequency.- Specified by:
tfnin classNormalizationlen- the field length.
-
toString
public java.lang.String toString()
Description copied from class:NormalizationSubclasses must override this method to return the code of the normalization formula. Refer to the original paper for the list.- Specified by:
toStringin classNormalization
-
getC
public float getC()
Returns thecparameter.- See Also:
NormalizationH2(float)
-
-