Class NormalizationH1

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private float c  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Explanation explain​(BasicStats stats, double tf, double len)
      Returns an explanation for the normalized term frequency.
      float getC()
      Returns the c parameter.
      double tfn​(BasicStats stats, double tf, double 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 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • c

        private final float c
    • Constructor Detail

      • NormalizationH1

        public NormalizationH1​(float c)
        Creates NormalizationH1 with the supplied parameter c.
        Parameters:
        c - hyper-parameter that controls the term frequency normalization with respect to the document length.
    • Method Detail

      • tfn

        public final double tfn​(BasicStats stats,
                                double tf,
                                double len)
        Description copied from class: Normalization
        Returns the normalized term frequency.
        Specified by:
        tfn in class Normalization
        len - the field length.
      • explain

        public Explanation explain​(BasicStats stats,
                                   double tf,
                                   double len)
        Description copied from class: Normalization
        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.

        Overrides:
        explain in class Normalization
      • 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 class Normalization