org.terrier.matching.models

Class TF_IDF

java.lang.Object

org.terrier.matching.models.WeightingModel

org.terrier.matching.models.TF_IDF

All Implemented Interfaces:

Serializable, Cloneable, Model

public class TF_IDF
extends WeightingModel

This class implements the TF_IDF weighting model. tf is given by Robertson's tf and idf is given by the standard Sparck Jones' idf [Sparck Jones, 1972].

Author:

Ben He, Gianni Amati, Vassilis Plachouras

See Also:

Serialized Form

Field Summary

Fields inherited from class org.terrier.matching.models.WeightingModel

averageDocumentLength, c, cs, documentFrequency, es, i, keyFrequency, numberOfDocuments, numberOfPointers, numberOfTokens, numberOfUniqueTerms, rq, termFrequency

Constructor Summary

Constructors

Constructor and Description
TF_IDF() A default constructor to make this model.
TF_IDF(double _b) Constructs an instance of TF_IDF

Method Summary

Methods

Modifier and Type	Method and Description
String	getInfo() Returns the name of the model, in this case "TF_IDF"
double	getParameter() Returns the b parameter to the ranking formula as set by setParameter()
double	score(double tf, double docLength) Uses TF_IDF to compute a weight for a term in a document.
double	score(double tf, double docLength, double documentFrequency, double termFrequency, double keyFrequency) Deprecated.
void	setParameter(double _b) Sets the b parameter to ranking formula

Methods inherited from class org.terrier.matching.models.WeightingModel

clone, getOverflowed, prepare, score, setCollectionStatistics, setEntryStatistics, setKeyFrequency, setRequest

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TF_IDF

public TF_IDF()

A default constructor to make this model.

TF_IDF

public TF_IDF(double _b)

Constructs an instance of TF_IDF

Parameters:

_b -

Method Detail

getInfo

public final String getInfo()

Returns the name of the model, in this case "TF_IDF"

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 TF_IDF 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

@Deprecated
public final double score(double tf,
                      double docLength,
                      double documentFrequency,
                      double termFrequency,
                      double keyFrequency)

Deprecated.

This method provides the contract for implementing weighting models. As of Terrier 3.6, the 5-parameter score method is being deprecated since it is not used. The two parameter score method should be used instead. Tagged for removal in a later version.

Specified by:

score in class WeightingModel

Parameters:

tf - The term frequency in the document

docLength - the document's length

documentFrequency - The document frequency of the term

termFrequency - the term frequency in the collection

keyFrequency - the term frequency in the query

Returns:

the score returned by the implemented weighting model.

setParameter

public void setParameter(double _b)

Sets the b parameter to ranking formula

Specified by:

setParameter in interface Model

Overrides:

setParameter in class WeightingModel

Parameters:

_b - the b parameter value to use.

getParameter

public double getParameter()

Returns the b parameter to the ranking formula as set by setParameter()

Specified by:

getParameter in interface Model

Overrides:

getParameter in class WeightingModel