Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

RetrievalMethod Class Reference

#include <RetrievalMethod.hpp>

Inheritance diagram for RetrievalMethod:

IndriRetMethod StructQueryRetMethod TextQueryRetMethod XLingRetMethod InQueryRetMethod CORIRetMethod CosSimRetMethod OkapiRetMethod SimpleKLRetMethod TFIDFRetMethod List of all members.

Public Methods

 RetrievalMethod (const Index &collectionIndex)
virtual ~RetrievalMethod ()
virtual QueryRepcomputeQueryRep (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 Indexind

Detailed Description

A retrieval method is determined by specifying the following elements


Constructor & Destructor Documentation

RetrievalMethod::RetrievalMethod const Index   collectionIndex [inline]
 

virtual RetrievalMethod::~RetrievalMethod   [inline, virtual]
 


Member Function Documentation

virtual QueryRep* RetrievalMethod::computeQueryRep const Query   qry [pure virtual]
 

compute the representation for a query, semantics defined by subclass

Implemented in IndriRetMethod, StructQueryRetMethod, TextQueryRetMethod, and XLingRetMethod.

void 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 CORIRetMethod, IndriRetMethod, StructQueryRetMethod, TextQueryRetMethod, and XLingRetMethod.

virtual double 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 IndriRetMethod, StructQueryRetMethod, TextQueryRetMethod, and XLingRetMethod.

void 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

Reimplemented in IndriRetMethod.

virtual void RetrievalMethod::updateQuery QueryRep   qryRep,
const DocIDSet   relDocs
[pure virtual]
 

update the query, feedback support

Implemented in IndriRetMethod, StructQueryRetMethod, TextQueryRetMethod, and XLingRetMethod.


Member Data Documentation

const Index& RetrievalMethod::ind [protected]
 


The documentation for this class was generated from the following files:
Generated on Wed Nov 3 12:59:54 2004 for Lemur Toolkit by doxygen1.2.18