Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

lemur::api::DocInfo Class Reference

Representation of Doc Information Entry. More...

#include <DocInfoList.hpp>

Inheritance diagram for lemur::api::DocInfo:

lemur::index::InvDocInfo lemur::index::InvFPDocInfo List of all members.

Public Member Functions

 DocInfo ()
 DocInfo (DOCID_T docID, COUNT_T termCount)
virtual ~DocInfo ()
virtual DOCID_T docID () const
 Doc id.

virtual void docID (DOCID_T id)
 Set doc id.

virtual COUNT_T termCount () const
 Term count in the doc.

virtual void termCount (COUNT_T c)
 Set term count.

virtual const LOC_Tpositions () const
virtual void positions (const LOC_T *pos)

Protected Attributes

COUNT_T tcount

Detailed Description

Representation of Doc Information Entry.

This is a class that represents the information associated with each doc entry in the term to doc index. The basic information includes the doc ID and the frequency of a term in the document.

Constructor & Destructor Documentation

lemur::api::DocInfo::DocInfo  )  [inline]

lemur::api::DocInfo::DocInfo DOCID_T  docID,
COUNT_T  termCount

virtual lemur::api::DocInfo::~DocInfo  )  [inline, virtual]

Member Function Documentation

virtual void lemur::api::DocInfo::docID DOCID_T  id  )  [inline, virtual]

Set doc id.

virtual DOCID_T lemur::api::DocInfo::docID  )  const [inline, virtual]

Doc id.

Reimplemented in lemur::index::InvDocInfo.

virtual void lemur::api::DocInfo::positions const LOC_T pos  )  [inline, virtual]

Set the list of positions Default implementation does nothing

virtual const LOC_T* lemur::api::DocInfo::positions  )  const [inline, virtual]

Return list of positions this term occurs in this document Default implementation to return NULL if no position information available for this DocInfo

Reimplemented in lemur::index::InvFPDocInfo.

virtual void lemur::api::DocInfo::termCount COUNT_T  c  )  [inline, virtual]

Set term count.

virtual COUNT_T lemur::api::DocInfo::termCount  )  const [inline, virtual]

Term count in the doc.

Reimplemented in lemur::index::InvDocInfo.

Member Data Documentation

DOCID_T lemur::api::DocInfo::did [protected]

COUNT_T lemur::api::DocInfo::tcount [protected]

The documentation for this class was generated from the following file:
Generated on Tue Jun 15 11:03:04 2010 for Lemur by doxygen 1.3.4