Class NormalizationH3
java.lang.Object
org.apache.lucene.search.similarities.Normalization
org.apache.lucene.search.similarities.NormalizationH3
Dirichlet Priors normalization
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.similarities.Normalization
Normalization.NoNormalization -
Constructor Summary
ConstructorsConstructorDescriptionCallsNormalizationH3(800)NormalizationH3(float mu) Creates NormalizationH3 with the supplied parameterμ. -
Method Summary
Modifier and TypeMethodDescriptionexplain(BasicStats stats, double tf, double len) Returns an explanation for the normalized term frequency.floatgetMu()Returns the parameterμdoubletfn(BasicStats stats, double tf, double len) Returns the normalized term frequency.toString()Subclasses must override this method to return the code of the normalization formula.
-
Constructor Details
-
NormalizationH3
public NormalizationH3()CallsNormalizationH3(800) -
NormalizationH3
public NormalizationH3(float mu) Creates NormalizationH3 with the supplied parameterμ.- Parameters:
mu- smoothing parameterμ
-
-
Method Details
-
tfn
Description copied from class:NormalizationReturns the normalized term frequency.- Specified by:
tfnin classNormalization- Parameters:
len- the field length.
-
explain
Description copied from class:NormalizationReturns 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.
- Overrides:
explainin classNormalization
-
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
-
getMu
public float getMu()Returns the parameterμ- See Also:
-