PerFieldNormWeightingModel (Terrier 4.0 API)

Field Summary

Fields
Modifier and Type	Field and Description
`protected BasicModel`	`basicModel`
`protected int`	`fieldCount`
`protected double[]`	`fieldGlobalFrequencies`
`protected Normalisation[]`	`fieldNormalisations`
`protected double[]`	`fieldWeights`
`protected String[]`	`params`

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
`PerFieldNormWeightingModel(Class<? extends BasicModel> _basicModel, Class<? extends Normalisation> _normalisationModel)` Constructs an instance of PerFieldNormWeightingModel
`PerFieldNormWeightingModel(String[] parameters)` Constructs an instance of PerFieldNormWeightingModel

Method Summary

Methods
Modifier and Type	Method and Description
`PerFieldNormWeightingModel`	`clone()` Clone this weighting model
`String`	`getInfo()` Returns the name of the model.
`void`	`prepare()` prepare
`double`	`score(double tf, double docLength)` This method provides the contract for implementing weighting models.
`double`	`score(double tf, double docLength, double n_t, double F_t, double keyFrequency)` Deprecated.
`double`	`score(Posting _p)` Returns score
`void`	`setCollectionStatistics(CollectionStatistics _cs)` Sets collection statistics
`void`	`setEntryStatistics(EntryStatistics _es)` Sets entry statistics.

Methods inherited from class org.terrier.matching.models.WeightingModel
getOverflowed, getParameter, setKeyFrequency, setParameter, setRequest

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - params
```
protected String[] params
```
  - basicModel
```
protected BasicModel basicModel
```
  - fieldNormalisations
```
protected Normalisation[] fieldNormalisations
```
  - fieldGlobalFrequencies
```
protected double[] fieldGlobalFrequencies
```
  - fieldWeights
```
protected double[] fieldWeights
```
  - fieldCount
```
protected int fieldCount
```
- Constructor Detail
  - PerFieldNormWeightingModel
```
public PerFieldNormWeightingModel(Class<? extends BasicModel> _basicModel,
                          Class<? extends Normalisation> _normalisationModel)
                           throws Exception
```
    Constructs an instance of PerFieldNormWeightingModel
    
    Parameters:
    _basicModel -
    _normalisationModel -
    
    Throws:
    
    Exception
  - PerFieldNormWeightingModel
```
public PerFieldNormWeightingModel(String[] parameters)
                           throws Exception
```
    Constructs an instance of PerFieldNormWeightingModel
    
    Parameters:
    parameters -
    
    Throws:
    
    Exception
- Method Detail
  - clone
```
public PerFieldNormWeightingModel clone()
```
    Description copied from class: WeightingModel
    
    Clone this weighting model
    
    Overrides:
    
    clone in class WeightingModel
  - prepare
```
public void prepare()
```
    Description copied from class: WeightingModel
    
    prepare
    
    Overrides:
    
    prepare in class WeightingModel
  - score
```
public double score(Posting _p)
```
    Description copied from class: WeightingModel
    
    Returns score
    
    Overrides:
    
    score in class WeightingModel
    
    Returns:
    score
  - setCollectionStatistics
```
public void setCollectionStatistics(CollectionStatistics _cs)
```
    Description copied from class: WeightingModel
    
    Sets collection statistics
    
    Overrides:
    
    setCollectionStatistics in class WeightingModel
  - setEntryStatistics
```
public void setEntryStatistics(EntryStatistics _es)
```
    Sets entry statistics.
    
    Overrides:
    
    setEntryStatistics in class WeightingModel
  - getInfo
```
public String getInfo()
```
    Returns the name of the model.
    
    Specified by:
    
    getInfo in interface Model
    
    Specified by:
    
    getInfo in class WeightingModel
    
    Returns:
    java.lang.String
  - score
```
public double score(double tf,
           double docLength)
```
    Description copied from class: WeightingModel
    
    This method provides the contract for implementing weighting models.
    
    Specified by:
    
    score in class WeightingModel
    
    Parameters:
    tf - The term frequency 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 double score(double tf,
                      double docLength,
                      double n_t,
                      double F_t,
                      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
    n_t - The document frequency of the term
    F_t - the term frequency in the collection
    keyFrequency - the term frequency in the query
    
    Returns:
    the score returned by the implemented weighting model.

Class PerFieldNormWeightingModel

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

params

basicModel

fieldNormalisations

fieldGlobalFrequencies

fieldWeights

fieldCount

Constructor Detail

PerFieldNormWeightingModel

PerFieldNormWeightingModel

Method Detail

clone

prepare

score

setCollectionStatistics

setEntryStatistics

getInfo

score

score