Terrier IR Platform
2.2.1

uk.ac.gla.terrier.matching.models
Class DFRee

java.lang.Object
  extended by uk.ac.gla.terrier.matching.models.WeightingModel
      extended by uk.ac.gla.terrier.matching.models.DFRee
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Model

public class DFRee
extends WeightingModel

This class implements the DFRee weighting model. DFRee stands for DFR free from parameters.

See Also:
Serialized Form

Constructor Summary
DFRee()
          A default constructor to make this model.
 
Method Summary
 java.lang.String getInfo()
          Returns the name of the model, in this case "DFRee"
 double score(double tf, double docLength)
          Uses DFRee to compute a weight for a term in a document.
 double score(double tf, double docLength, double documentFrequency, double termFrequency, double keyFrequency)
          Uses DFRee to compute a weight for a term in a document.
 
Methods inherited from class uk.ac.gla.terrier.matching.models.WeightingModel
clone, getParameter, setAverageDocumentLength, setDocumentFrequency, setKeyFrequency, setNumberOfDocuments, setNumberOfPointers, setNumberOfTokens, setNumberOfUniqueTerms, setParameter, setTermFrequency, stirlingPower
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DFRee

public DFRee()
A default constructor to make this model.

Method Detail

getInfo

public final java.lang.String getInfo()
Returns the name of the model, in this case "DFRee"

Specified by:
getInfo in interface Model
Specified by:
getInfo in class WeightingModel
Returns:
the name of the model

score

public final double score(double tf,
                          double docLength)
Uses DFRee to compute a weight for a term in a document.

Specified by:
score in class WeightingModel
Parameters:
tf - The term frequency of the term in the document
docLength - the document's length
Returns:
the score assigned to a document with the given tf and docLength, and other preset parameters

score

public final double score(double tf,
                          double docLength,
                          double documentFrequency,
                          double termFrequency,
                          double keyFrequency)
Uses DFRee to compute a weight for a term in a document.

Specified by:
score in class WeightingModel
Parameters:
tf - The term frequency of the term in the document
docLength - the document's length
documentFrequency - The document frequency of the term (ignored)
termFrequency - the term frequency in the collection (ignored)
keyFrequency - the term frequency in the query (ignored).
Returns:
the score assigned by the weighting model DFRee.

Terrier IR Platform
2.2.1

Terrier Information Retrieval Platform 2.2.1. Copyright 2004-2008 University of Glasgow