---

TextQueryRetMethod.hpp

Go to the documentation of this file.

/*==========================================================================
 *
 *  Original source copyright (c) 2001, Carnegie Mellon University.
 *  See copyright.cmu for details.
 *  Modifications copyright (c) 2002, University of Massachusetts.
 *  See copyright.umass for details.
 *
 *==========================================================================
*/


#ifndef _TEXTQUERYRETMETHOD_HPP
#define _TEXTQUERYRETMETHOD_HPP


#include "RetrievalMethod.hpp"
#include "TextQueryRep.hpp"
#include "DocumentRep.hpp"
#include "ScoreFunction.hpp"
#include "ScoreAccumulator.hpp"
#include "FreqVector.hpp"
#include "Param.hpp"
//----------------------------------------------------------------------
//      Abstract Interface for A Retrieval Method/Model for Text Query
//----------------------------------------------------------------------

class TextQueryRetMethod : public RetrievalMethod {
public:
  TextQueryRetMethod(Index &ind, ScoreAccumulator & accumulator) : 
    RetrievalMethod(ind), scAcc(accumulator) {
    cacheDocReps = (ParamGetInt("cacheDocReps", 1) == 1);
    if (cacheDocReps) {
      docRepsSize = ind.docCount() + 1;
      docReps = new DocumentRep *[docRepsSize];
      for (int i = 0; i <= ind.docCount(); i++) docReps[i] = NULL;
    }
  }
  virtual ~TextQueryRetMethod() {
    if (cacheDocReps) {
      for (int i = 0; i < docRepsSize; i++) delete(docReps[i]);
      delete[](docReps);
    }
  }

  virtual TextQueryRep *computeTextQueryRep(TextQuery &qry)=0;
  virtual TextQueryRep *computeTextQueryRep(int docid){
    return NULL; 
  } // need to implement for other ret methods.
  virtual QueryRep *computeQueryRep(Query &qry); 

  virtual double scoreDoc(QueryRep &qry, int docID);
  virtual void scoreCollection(QueryRep &qry, IndexedRealVector &results);
  virtual void scoreCollection(int docid, IndexedRealVector &results);
  
  virtual DocumentRep *computeDocRep(int docID) =0;
  virtual ScoreFunction *scoreFunc() = 0;
  virtual void updateQuery(QueryRep &qryRep, DocIDSet &relDocs) {
    updateTextQuery(*((TextQueryRep *)(&qryRep)), relDocs);
  }

  virtual void updateTextQuery(TextQueryRep &qryRep, DocIDSet &relDocs)=0;


  virtual void scoreInvertedIndex(QueryRep &qryRep, IndexedRealVector &scores, bool scoreAll=false);

  virtual double scoreDocVector(TextQueryRep &qry, int docID, FreqVector &docVector);

protected:
  ScoreAccumulator &scAcc;
  DocumentRep **docReps;
  bool cacheDocReps;
  int docRepsSize;
};


//=============== inlines ========================================

inline QueryRep *TextQueryRetMethod::computeQueryRep(Query &qry) { 
  TextQuery *q = static_cast<TextQuery *>(&qry);
  return (computeTextQueryRep(*q));
}

#endif /* _TEXTQUERYRETMETHOD_HPP */

---