lemur::api::DocumentRep Class Reference

Representation of documents in a collection for efficient inverted index scoring. More...

#include <DocumentRep.hpp>

Inheritance diagram for lemur::api::DocumentRep:

List of all members.

Public Member Functions
	DocumentRep (DOCID_T docID, int dl=1)
virtual	~DocumentRep ()
virtual double	termWeight (TERMID_T termID, const DocInfo *info) const =0
	term weighting function TextQueryRetMethod
virtual double	scoreConstant () const =0
	doc-specific constant term in the scoring formula TextQueryRetMethod
void	setDocLength (int len)
int	getDocLength () const
DOCID_T	getID () const
Protected Attributes
DOCID_T	id
int	docLength

---

Detailed Description

Representation of documents in a collection for efficient inverted index scoring.

---

Constructor & Destructor Documentation

lemur::api::DocumentRep::DocumentRep (  DOCID_T  docID, int  dl = 1 )  [inline]

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

---

Member Function Documentation

int lemur::api::DocumentRep::getDocLength (   )  const [inline]

get the length of the document. Used by PassageRep. Returns: the new length.

DOCID_T lemur::api::DocumentRep::getID (   )  const [inline]

get the document id. Used by PassageRep. Returns: the id.

virtual double lemur::api::DocumentRep::scoreConstant (   )  const [pure virtual]

doc-specific constant term in the scoring formula TextQueryRetMethod Implemented in lemur::retrieval::CORIDocRep, lemur::retrieval::CosSimDocRep, lemur::retrieval::OkapiDocRep, lemur::retrieval::PassageRep, lemur::retrieval::SimpleKLDocModel, lemur::retrieval::StructQryDocRep, lemur::retrieval::TFIDFDocRep, and lemur::retrieval::XLingDocModel.

void lemur::api::DocumentRep::setDocLength (  int  len  )  [inline]

set the length of the document. Used by PassageRep. Parameters: len  the new length.

virtual double lemur::api::DocumentRep::termWeight (  TERMID_T  termID, const DocInfo *  info )  const [pure virtual]

term weighting function TextQueryRetMethod

---

Member Data Documentation

int lemur::api::DocumentRep::docLength [protected]

DOCID_T lemur::api::DocumentRep::id [protected]

---

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

• DocumentRep.hpp

---