org.terrier.matching.models.basicmodel

Class In

java.lang.Object

org.terrier.matching.models.basicmodel.BasicModel

org.terrier.matching.models.basicmodel.In

All Implemented Interfaces:

Serializable, Cloneable

public class In
extends BasicModel

This class implements the In basic model for randomness.

Author:

Ben He

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	modelName The name of the model.
protected double	numberOfDocuments The number of documents in the whole collection.

Fields inherited from class org.terrier.matching.models.basicmodel.BasicModel

i, numberOfTokens

Constructor Summary

Constructors

Constructor and Description
In() A default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getInfo() Returns the name of the model.
double	score(double tf, double documentFrequency, double termFrequency, double keyFrequency, double documentLength) This method computes the score for the implemented weighting model.

Methods inherited from class org.terrier.matching.models.basicmodel.BasicModel

clone, setNumberOfDocuments, setNumberOfTokens, stirlingPower

Methods inherited from class java.lang.Object

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

Field Detail

modelName

protected String modelName

The name of the model.

numberOfDocuments

protected double numberOfDocuments

The number of documents in the whole collection.

Constructor Detail

In

public In()

A default constructor.

Method Detail

getInfo

public String getInfo()

Returns the name of the model.

Specified by:

getInfo in class BasicModel

Returns:

the name of the model

score

public double score(double tf,
           double documentFrequency,
           double termFrequency,
           double keyFrequency,
           double documentLength)

This method computes the score for the implemented weighting model.

Specified by:

score in class BasicModel

Parameters:

tf - The term frequency in the document

documentFrequency - The document frequency of the term

termFrequency - the term frequency in the collection

documentLength - The length of the document.

keyFrequency - The normalised query term frequency.

Returns:

the score returned by the implemented weighting model.