org.terrier.matching.models.basicmodel

Class P

java.lang.Object

org.terrier.matching.models.basicmodel.BasicModel

org.terrier.matching.models.basicmodel.P

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

PL

public class P
extends BasicModel

This class implements the P basic model for randomness.

Author:

Gianni Amati, Ben He, Vassilis Plachouras

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	modelName The name of the model.

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

i, numberOfDocuments, numberOfTokens

Constructor Summary

Constructors

Constructor and Description
P() 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 provides the contract for implementing weighting models.

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.

Constructor Detail

P

public P()

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 provides the contract for implementing weighting models.

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.