Model (Terrier Information Retrieval Platform 5.5 API)

All Known Implementing Classes:

BB2, BM25, BM25F, CoordinateMatch, DFIC, DFIZ, DFR_BM25, DFRee, DFReeKLIM, DFRWeightingModel, DirichletLM, Dl, DLH, DLH13, DPH, Hiemstra_LM, IFB2, In_expB2, In_expC2, InB2, InL2, Js_KLs, LemurTF_IDF, LGD, MDL2, ML2, MRF, Null, pBiL, pBiL2, PerFieldNormWeightingModel, PL2, PL2F, RequiredTermModifier, SingleFieldModel, StaticFeature, StaticScoreModifierWeightingModel, TermInFieldModifier, Tf, TF_IDF, WeightingModel, XSqrA_M
```
public interface Model
```
This interface encapsulates all the common functionality between standard IR models (including DFR models, TF/IDF, BM25 etc), and Language Modelling models (Terrier includes PonteCroft Language Modelling model).

Author:

Craig Macdonald

See Also:

WeightingModel

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getInfo()`	Returns a model dependant string, such that runs can be identified from TREC results.
`double`	`getParameter()`	Returns the current value of the parameter set using setParameter() method.
`void`	`setParameter(double param)`	Many models require 1 parameter to be set - this is often dependant on the corpus and the model, so should be set for each Terrier instance.

- Method Detail
  - getInfo
```
java.lang.String getInfo()
```
    Returns a model dependant string, such that runs can be identified from TREC results. Example PL2c2.1 would imply PL2 model, with the c parameter set to 2.1.
    
    Returns:
    
    The string description of the current instantiation of the weighting model.
  - setParameter
```
void setParameter(double param)
```
    Many models require 1 parameter to be set - this is often dependant on the corpus and the model, so should be set for each Terrier instance.
    
    Parameters:
    
    param - double the parameter value.
  - getParameter
```
double getParameter()
```
    Returns the current value of the parameter set using setParameter() method.