---

InvTermList Class Reference

#include <InvTermList.hpp>

Inheritance diagram for InvTermList:

List of all members.

Public Methods
	InvTermList ()
	~InvTermList ()
void	startIteration () const
	prepare iteration
bool	hasMore () const
	has more entries
TermInfo *	nextEntry () const
	Get a pointer to the next entry (pointer to a local static memory).
COUNT_T	docLength () const
	Get the length of this document.
COUNT_T	termCount () const
	Get the number of terms in this document.
DOCID_T	docID () const
	Get the docid this list is for.
bool	binRead (ifstream &infile)
Protected Methods
virtual TermInfo *	getElement (TermInfo *elem, POS_T position) const
	set element from position, returns pointer to the element
virtual POS_T	beginPosition () const
	position at beginning of list
virtual POS_T	endPosition () const
	position at end of list
virtual POS_T	nextPosition (POS_T position) const
	advance position

---

Detailed Description

This is a class that represents the term entries in doc index, to be used with InvFPIndex i.e., the ID and frequency of all terms in a document.

---

Constructor & Destructor Documentation

InvTermList::InvTermList (    )

InvTermList::~InvTermList (    )

---

Member Function Documentation

virtual POS_T InvTermList::beginPosition (    )  const [inline, protected, virtual]

position at beginning of list Implements TermInfoList.

bool InvTermList::binRead (  ifstream &    infile )

Read in a TermInfoList object from a file Assumes the following format: DOCID DOCLENGTH TID TERM_COUNT ..

DOCID_T InvTermList::docID (    )  const [inline]

Get the docid this list is for.

COUNT_T InvTermList::docLength (    )  const [inline]

Get the length of this document.

virtual POS_T InvTermList::endPosition (    )  const [inline, protected, virtual]

position at end of list Implements TermInfoList.

TermInfo * InvTermList::getElement (  TermInfo *    elem, POS_T    position )  const [protected, virtual]

set element from position, returns pointer to the element Implements TermInfoList.

bool InvTermList::hasMore (    )  [virtual]

has more entries Implements TermInfoList.

TermInfo * InvTermList::nextEntry (    )  [virtual]

Get a pointer to the next entry (pointer to a local static memory). Implements TermInfoList.

POS_T InvTermList::nextPosition (  POS_T    position )  const [protected, virtual]

advance position Implements TermInfoList.

void InvTermList::startIteration (    )  [virtual]

prepare iteration Implements TermInfoList.

COUNT_T InvTermList::termCount (    )  const [inline]

Get the number of terms in this document.

---

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

• InvTermList.hpp
• InvTermList.cpp

---