lemur::retrieval::SimpleKLRetMethod Class Reference

KL Divergence retrieval model with simple document model smoothing. More...

#include <SimpleKLRetMethod.hpp>

Inheritance diagram for lemur::retrieval::SimpleKLRetMethod:

List of all members.

Public Member Functions
	SimpleKLRetMethod (const lemur::api::Index &dbIndex, const string &supportFileName, lemur::api::ScoreAccumulator &accumulator)
	Construction of SimpleKLRetMethod requires a smoothing support file, which can be generated by the application GenerateSmoothSupport. The use of this smoothing support file is to store some pre-computed quantities so that the scoring procedure can be speeded up.
virtual	~SimpleKLRetMethod ()
virtual lemur::api::TextQueryRep *	computeTextQueryRep (const lemur::api::TermQuery &qry)
virtual lemur::api::DocumentRep *	computeDocRep (lemur::api::DOCID_T docID)
	compute the doc representation (caller responsible for deleting the memory of the generated new instance)
virtual lemur::api::ScoreFunction *	scoreFunc ()
	return the scoring function pointer
virtual void	updateTextQuery (lemur::api::TextQueryRep &origRep, const lemur::api::DocIDSet &relDocs)
void	setDocSmoothParam (SimpleKLParameter::DocSmoothParam &docSmthParam)
void	setQueryModelParam (SimpleKLParameter::QueryModelParam &queryModParam)
Protected Member Functions
void	loadSupportFile ()
	Load support file support.
query model updating methods (i.e., feedback methods)
void	computeMixtureFBModel (SimpleKLQueryModel &origRep, const lemur::api::DocIDSet &relDocs)
	Mixture model feedback method.
void	computeDivMinFBModel (SimpleKLQueryModel &origRep, const lemur::api::DocIDSet &relDocs)
	Divergence minimization feedback method.
void	computeMarkovChainFBModel (SimpleKLQueryModel &origRep, const lemur::api::DocIDSet &relDocs)
	Markov chain feedback method.
void	computeRM1FBModel (SimpleKLQueryModel &origRep, const lemur::api::DocIDSet &relDocs)
	Relevance model1 feedback method.
void	computeRM2FBModel (SimpleKLQueryModel &origRep, const lemur::api::DocIDSet &relDocs)
	Relevance model1 feedback method.
Protected Attributes
double *	mcNorm
	needed for fast one-step Markov chain
double *	docProbMass
	needed for fast alpha computing
lemur::api::COUNT_T *	uniqueTermCount
	needed for supporting fast absolute discounting
lemur::langmod::UnigramLM *	collectLM
	a little faster if pre-computed
lemur::langmod::DocUnigramCounter *	collectLMCounter
	support the construction of collectLM
SimpleKLScoreFunc *	scFunc
	keep a copy to be used at any time
SimpleKLParameter::DocSmoothParam	docParam
SimpleKLParameter::QueryModelParam	qryParam
const string	supportFile

---

Detailed Description

KL Divergence retrieval model with simple document model smoothing.

---

Constructor & Destructor Documentation

lemur::retrieval::SimpleKLRetMethod::SimpleKLRetMethod (  const lemur::api::Index &  dbIndex, const string &  supportFileName, lemur::api::ScoreAccumulator &  accumulator )

Construction of SimpleKLRetMethod requires a smoothing support file, which can be generated by the application GenerateSmoothSupport. The use of this smoothing support file is to store some pre-computed quantities so that the scoring procedure can be speeded up.

lemur::retrieval::SimpleKLRetMethod::~SimpleKLRetMethod (   )  [virtual]

---

Member Function Documentation

void lemur::retrieval::SimpleKLRetMethod::computeDivMinFBModel (  SimpleKLQueryModel &  origRep, const lemur::api::DocIDSet &  relDocs )  [protected]

Divergence minimization feedback method.

DocumentRep * lemur::retrieval::SimpleKLRetMethod::computeDocRep (  lemur::api::DOCID_T  docID  )  [virtual]

compute the doc representation (caller responsible for deleting the memory of the generated new instance) Implements lemur::api::TextQueryRetMethod.

void lemur::retrieval::SimpleKLRetMethod::computeMarkovChainFBModel (  SimpleKLQueryModel &  origRep, const lemur::api::DocIDSet &  relDocs )  [protected]

Markov chain feedback method.

void lemur::retrieval::SimpleKLRetMethod::computeMixtureFBModel (  SimpleKLQueryModel &  origRep, const lemur::api::DocIDSet &  relDocs )  [protected]

Mixture model feedback method.

void lemur::retrieval::SimpleKLRetMethod::computeRM1FBModel (  SimpleKLQueryModel &  origRep, const lemur::api::DocIDSet &  relDocs )  [protected]

Relevance model1 feedback method.

void lemur::retrieval::SimpleKLRetMethod::computeRM2FBModel (  SimpleKLQueryModel &  origRep, const lemur::api::DocIDSet &  relDocs )  [protected]

Relevance model1 feedback method.

virtual lemur::api::TextQueryRep* lemur::retrieval::SimpleKLRetMethod::computeTextQueryRep (  const lemur::api::TermQuery &  qry  )  [inline, virtual]

void lemur::retrieval::SimpleKLRetMethod::loadSupportFile (   )  [protected]

Load support file support.

virtual lemur::api::ScoreFunction* lemur::retrieval::SimpleKLRetMethod::scoreFunc (   )  [inline, virtual]

return the scoring function pointer Implements lemur::api::TextQueryRetMethod.

void lemur::retrieval::SimpleKLRetMethod::setDocSmoothParam (  SimpleKLParameter::DocSmoothParam &  docSmthParam  )  [inline]

void lemur::retrieval::SimpleKLRetMethod::setQueryModelParam (  SimpleKLParameter::QueryModelParam &  queryModParam  )  [inline]

virtual void lemur::retrieval::SimpleKLRetMethod::updateTextQuery (  lemur::api::TextQueryRep &  origRep, const lemur::api::DocIDSet &  relDocs )  [virtual]

---

Member Data Documentation

lemur::langmod::UnigramLM* lemur::retrieval::SimpleKLRetMethod::collectLM [protected]

a little faster if pre-computed

lemur::langmod::DocUnigramCounter* lemur::retrieval::SimpleKLRetMethod::collectLMCounter [protected]

support the construction of collectLM

SimpleKLParameter::DocSmoothParam lemur::retrieval::SimpleKLRetMethod::docParam [protected]

double* lemur::retrieval::SimpleKLRetMethod::docProbMass [protected]

needed for fast alpha computing

double* lemur::retrieval::SimpleKLRetMethod::mcNorm [protected]

needed for fast one-step Markov chain

SimpleKLParameter::QueryModelParam lemur::retrieval::SimpleKLRetMethod::qryParam [protected]

SimpleKLScoreFunc* lemur::retrieval::SimpleKLRetMethod::scFunc [protected]

keep a copy to be used at any time

const string lemur::retrieval::SimpleKLRetMethod::supportFile [protected]

lemur::api::COUNT_T* lemur::retrieval::SimpleKLRetMethod::uniqueTermCount [protected]

needed for supporting fast absolute discounting

---

The documentation for this class was generated from the following files:

• SimpleKLRetMethod.hpp
• SimpleKLRetMethod.cpp

---