---

RetrievalMethod.hpp

Go to the documentation of this file.

/*==========================================================================
 * Copyright (c) 2001 Carnegie Mellon University.  All Rights Reserved.
 *
 * Use of the Lemur Toolkit for Language Modeling and Information Retrieval
 * is subject to the terms of the software license set forth in the LICENSE
 * file included with this software, and also available at
 * http://www.lemurproject.org/license.html
 *
 *==========================================================================
*/


#ifndef _RETRIEVALMETHOD_HPP
#define _RETRIEVALMETHOD_HPP


#include "Index.hpp"
#include "WeightedIDSet.hpp"
#include "IndexedReal.hpp"

//------------------------------------------------------------
//      Abstract Interface for A Query
//------------------------------------------------------------

class Query {
public:
  virtual ~Query() {}

  virtual const string& id() const { return qid; }
  virtual void id(const string& str) { qid = str; }

protected:
  string qid;
};


class QueryRep {
public:
  virtual ~QueryRep(){}
};


//------------------------------------------------------------
//      Abstract Interface for Feedback Document Subset
//------------------------------------------------------------

typedef WeightedIDSet DocIDSet;


//------------------------------------------------------------
//      Abstract Interface for A Retrieval Method/Model
//------------------------------------------------------------



class RetrievalMethod {
public:
  RetrievalMethod(const Index &collectionIndex) : ind(collectionIndex) {}
  virtual ~RetrievalMethod() {}

  virtual QueryRep *computeQueryRep(const Query &qry)=0;

  virtual double scoreDoc(const QueryRep &qry, DOCID_T docID)=0;


  virtual void scoreDocSet(const QueryRep &qry, const DocIDSet &docSet, IndexedRealVector &results);
  

  virtual void scoreCollection(const QueryRep &qry, IndexedRealVector &results);

  virtual void updateQuery (QueryRep &qryRep, const DocIDSet &relDocs) = 0;

protected:
  const Index &ind;
};

#endif /* _RETRIEVALMETHOD_HPP */

---