Class NormalisationF

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class NormalisationF
    extends Normalisation
    This class implements an increasing density function for the frequency normalisation.
    Author:
    Ben He
    See Also:
    Serialized Form
    • Field Detail

      • methodName

        protected final java.lang.String methodName
        The name of the normalisation method .
        See Also:
        Constant Field Values
    • Constructor Detail

      • NormalisationF

        public NormalisationF()
        The default constructor.
      • NormalisationF

        public NormalisationF​(double value)
        The constructor that also sets the parameter mu of the Dirichlet Normalisation.
        Parameters:
        value - The specified value for the parameter mu.
    • Method Detail

      • getInfo

        public java.lang.String getInfo()
        Get the name of the normalisation method.
        Specified by:
        getInfo in class Normalisation
        Returns:
        Return the name of the normalisation method.
      • normalise

        public double normalise​(double tf,
                                double docLength,
                                double termFrequency)
        This method gets the normalised term frequency.
        Specified by:
        normalise in class Normalisation
        Parameters:
        tf - The frequency of the query term in the document.
        docLength - The number of tokens in the document.
        termFrequency - The frequency of the query term in the collection.
        Returns:
        The normalised term frequency.