org.terrier.matching.models.normalisation
Class Normalisation3

java.lang.Object
  extended by org.terrier.matching.models.normalisation.Normalisation
      extended by org.terrier.matching.models.normalisation.Normalisation3
All Implemented Interfaces:
java.io.Serializable

public class Normalisation3
extends Normalisation

This class implements the Dirichlet Priors normalisation.

Author:
Gianni Amati, Ben He
See Also:
Serialized Form

Field Summary
protected  java.lang.String methodName
          The name of the normalisation method .
 
Fields inherited from class org.terrier.matching.models.normalisation.Normalisation
averageDocumentLength, idf, Nt, numberOfDocuments, numberOfTokens, parameter, termFrequency
 
Constructor Summary
Normalisation3()
          The default constructor.
Normalisation3(double value)
          The constructor that also sets the parameter mu of the Dirichlet Normalisation.
 
Method Summary
 java.lang.String getInfo()
          Get the name of the normalisation method.
 double normalise(double tf, double docLength, double termFrequency)
          This method gets the normalised term frequency.
 
Methods inherited from class org.terrier.matching.models.normalisation.Normalisation
getParameter, setAverageDocumentLength, setDocumentFrequency, setNumberOfDocuments, setNumberOfTokens, setParameter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

methodName

protected final java.lang.String methodName
The name of the normalisation method .

See Also:
Constant Field Values
Constructor Detail

Normalisation3

public Normalisation3()
The default constructor.


Normalisation3

public Normalisation3(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 as a string

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.


Terrier 3.5. Copyright © 2004-2011 University of Glasgow