lemur::api::RetrievalMethod Class Reference

#include <RetrievalMethod.hpp>

Inheritance diagram for lemur::api::RetrievalMethod:

List of all members.

Public Member Functions
	RetrievalMethod (const Index &collectionIndex)
virtual	~RetrievalMethod ()
virtual QueryRep *	computeQueryRep (const Query &qry)=0
	compute the representation for a query, semantics defined by subclass
virtual double	scoreDoc (const QueryRep &qry, DOCID_T docID)=0
	Score a document identified by the id w.r.t. a query rep.
virtual void	scoreDocSet (const QueryRep &qry, const DocIDSet &docSet, IndexedRealVector &results)
	Score a set of documents w.r.t. a query rep (e.g. for re-ranking).
virtual void	scoreCollection (const QueryRep &qry, IndexedRealVector &results)
	Score all documents in the collection.
virtual void	updateQuery (QueryRep &qryRep, const DocIDSet &relDocs)=0
	update the query, feedback support
Protected Attributes
const Index &	ind

---

Detailed Description

A retrieval method is determined by specifying the following elements

• A method to compute the query representation
• A method to score a document w.r.t. a query representation
• A method to score all the documents in the collection w.r.t. a query representation
• A method to update the query representation based on a set of (relevant) documents

---

Constructor & Destructor Documentation

lemur::api::RetrievalMethod::RetrievalMethod (  const Index &  collectionIndex  )  [inline]

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

---

Member Function Documentation

virtual QueryRep* lemur::api::RetrievalMethod::computeQueryRep (  const Query &  qry  )  [pure virtual]

compute the representation for a query, semantics defined by subclass Implemented in lemur::api::StructQueryRetMethod, and lemur::api::TextQueryRetMethod.

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

Score all documents in the collection. The default implementation provided by this class is to call function scoreDoc, thus to score documents one by one. This is inefficient, so usually a subclass should override this method if a more efficient scoring, e.g., based on inverted index, is possible. Reimplemented in lemur::api::StructQueryRetMethod, and lemur::api::TextQueryRetMethod.

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

Score a document identified by the id w.r.t. a query rep. Implemented in lemur::api::StructQueryRetMethod, and lemur::api::TextQueryRetMethod.

void lemur::api::RetrievalMethod::scoreDocSet (  const QueryRep &  qry, const DocIDSet &  docSet, IndexedRealVector &  results )  [virtual]

Score a set of documents w.r.t. a query rep (e.g. for re-ranking). The default implementation provided by this class is to call function scoreDoc

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

update the query, feedback support Implemented in lemur::api::StructQueryRetMethod, and lemur::api::TextQueryRetMethod.

---

Member Data Documentation

const Index& lemur::api::RetrievalMethod::ind [protected]

---

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

• RetrievalMethod.hpp
• RetrievalMethod.cpp

---