lemur::api::StructQueryRetMethod Class Reference

Abstract Interface for A Retrieval Method/Model for Structured Query. More...

#include <StructQueryRetMethod.hpp>

Inheritance diagram for lemur::api::StructQueryRetMethod:

List of all members.

Public Member Functions
	StructQueryRetMethod (const Index &ind)
virtual	~StructQueryRetMethod ()
virtual lemur::retrieval::StructQueryRep *	computeStructQueryRep (const TermQuery &qry)=0
	compute the query representation for a text query
virtual QueryRep *	computeQueryRep (const Query &qry)
	overriding abstract class method
virtual double	scoreDoc (const QueryRep &qry, DOCID_T docID)
	score the query against the given document id.
virtual void	scoreCollection (const QueryRep &qry, IndexedRealVector &results)
	score the query against the collection.
virtual DocumentRep *	computeDocRep (DOCID_T docID)=0
virtual ScoreFunction *	scoreFunc ()=0
	return the scoring function pointer
virtual void	updateQuery (QueryRep &qryRep, const DocIDSet &relDocs)
	update the query
virtual void	updateStructQuery (lemur::retrieval::StructQueryRep &qryRep, const DocIDSet &relDocs)=0
virtual void	scoreInvertedIndex (const QueryRep &qryRep, IndexedRealVector &scores, bool scoreAll=false)
	Scoring with the inverted index.

---

Detailed Description

Abstract Interface for A Retrieval Method/Model for Structured Query.

Given a query q = op(q1,q2,...,qN) where q_i can be an structured query node or a term node, and a document d, StructQueryRetMethod assumes the following general scoring function:

      s(q,d) = g(s(q1,d), ..., s(qN,d))
      

That is, the score of a document d against a query q is a function g of the scores of each child query node in qi, where g is the composition function for q, such as average.

---

Constructor & Destructor Documentation

lemur::api::StructQueryRetMethod::StructQueryRetMethod (  const Index &  ind  )  [inline]

virtual lemur::api::StructQueryRetMethod::~StructQueryRetMethod (   )  [inline, virtual]

---

Member Function Documentation

virtual DocumentRep* lemur::api::StructQueryRetMethod::computeDocRep (  DOCID_T  docID  )  [pure virtual]

compute the doc representation (caller responsible for deleting the memory of the generated new instance) Implemented in lemur::retrieval::InQueryRetMethod.

QueryRep * lemur::api::StructQueryRetMethod::computeQueryRep (  const Query &  qry  )  [inline, virtual]

overriding abstract class method Implements lemur::api::RetrievalMethod.

virtual lemur::retrieval::StructQueryRep* lemur::api::StructQueryRetMethod::computeStructQueryRep (  const TermQuery &  qry  )  [pure virtual]

compute the query representation for a text query

void lemur::api::StructQueryRetMethod::scoreCollection (  const QueryRep &  qry, IndexedRealVector &  results )  [virtual]

score the query against the collection. Reimplemented from lemur::api::RetrievalMethod.

double lemur::api::StructQueryRetMethod::scoreDoc (  const QueryRep &  qry, DOCID_T  docID )  [virtual]

score the query against the given document id. Implements lemur::api::RetrievalMethod.

virtual ScoreFunction* lemur::api::StructQueryRetMethod::scoreFunc (   )  [pure virtual]

return the scoring function pointer Implemented in lemur::retrieval::InQueryRetMethod.

void lemur::api::StructQueryRetMethod::scoreInvertedIndex (  const QueryRep &  qryRep, IndexedRealVector &  scores, bool  scoreAll = false )  [virtual]

Scoring with the inverted index.

virtual void lemur::api::StructQueryRetMethod::updateQuery (  QueryRep &  qryRep, const DocIDSet &  relDocs )  [inline, virtual]

update the query Implements lemur::api::RetrievalMethod.

virtual void lemur::api::StructQueryRetMethod::updateStructQuery (  lemur::retrieval::StructQueryRep &  qryRep, const DocIDSet &  relDocs )  [pure virtual]

Modify/update the query representation based on a set (presumably) relevant documents

---

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

• StructQueryRetMethod.hpp
• StructQueryRetMethod.cpp

---