lemur::index::InvFPDocList Class Reference

#include <InvFPDocList.hpp>

Inheritance diagram for lemur::index::InvFPDocList:

List of all members.

Public Member Functions
	InvFPDocList ()
	InvFPDocList (lemur::api::LOC_T *vec)
	copy from byteVector
	InvFPDocList (lemur::api::TERMID_T id, int len)
	InvFPDocList (lemur::utility::MemCache *mc, lemur::api::TERMID_T id, int len)
	constructors for this list getting memory from a MemCache
	InvFPDocList (lemur::utility::MemCache *mc, lemur::api::TERMID_T id, int len, lemur::api::DOCID_T docid, lemur::api::LOC_T location)
	InvFPDocList (lemur::api::TERMID_T id, int listlen, lemur::api::LOC_T *list, int fr, lemur::api::DOCID_T *ldocid, int len)
	constructor for a list not needing to get any memory
	~InvFPDocList ()
bool	addTerm (lemur::api::DOCID_T docid)
	increase count for this docid, we don't care about location
bool	addLocation (lemur::api::DOCID_T docid, lemur::api::LOC_T location)
bool	append (InvDocList *tail)
	append the given list to the end of this list. watch for overlap of lastdocid of this list and first docid of given list.
virtual lemur::api::DocInfo *	nextEntry () const
	fetch the next entry, return a pointer to a local static memory, so do not delete it
virtual void	nextEntry (lemur::api::DocInfo *info) const
virtual void	nextEntry (InvFPDocInfo *info) const
virtual lemur::api::COUNT_T	termCTF () const
lemur::api::LOC_T *	byteVec (lemur::api::COUNT_T &len)
Protected Member Functions
virtual lemur::api::DocInfo *	newElement () const
	create new element of this list type for the iterator
virtual lemur::api::DocInfo *	getElement (lemur::api::DocInfo *elem, lemur::api::POS_T position) const
	set element from position, returns pointer to the element
virtual void	assignElement (lemur::api::DocInfo *to, lemur::api::DocInfo *from) const
	copy values from one Element (of type InvFPDocInfo) to another
virtual lemur::api::POS_T	nextPosition (lemur::api::POS_T position) const
	advance position
virtual void	deltaEncode ()
virtual void	deltaDecode ()
Private Attributes
InvFPDocInfo	entry

---

Constructor & Destructor Documentation

lemur::index::InvFPDocList::InvFPDocList (   )

lemur::index::InvFPDocList::InvFPDocList (  lemur::api::LOC_T *  vec  )

copy from byteVector

lemur::index::InvFPDocList::InvFPDocList (  lemur::api::TERMID_T  id, int  len )

constructor for this list using malloc for its own memory usage of InvFPDocList without MemCache has not been tested

lemur::index::InvFPDocList::InvFPDocList (  lemur::utility::MemCache *  mc, lemur::api::TERMID_T  id, int  len )

constructors for this list getting memory from a MemCache

lemur::index::InvFPDocList::InvFPDocList (  lemur::utility::MemCache *  mc, lemur::api::TERMID_T  id, int  len, lemur::api::DOCID_T  docid, lemur::api::LOC_T  location )

lemur::index::InvFPDocList::InvFPDocList (  lemur::api::TERMID_T  id, int  listlen, lemur::api::LOC_T *  list, int  fr, lemur::api::DOCID_T *  ldocid, int  len )

constructor for a list not needing to get any memory

lemur::index::InvFPDocList::~InvFPDocList (   )

---

Member Function Documentation

bool lemur::index::InvFPDocList::addLocation (  lemur::api::DOCID_T  docid, lemur::api::LOC_T  location )

bool lemur::index::InvFPDocList::addTerm (  lemur::api::DOCID_T  docid  )  [virtual]

increase count for this docid, we don't care about location Reimplemented from lemur::index::InvDocList.

bool lemur::index::InvFPDocList::append (  InvDocList *  tail  )  [virtual]

append the given list to the end of this list. watch for overlap of lastdocid of this list and first docid of given list. Reimplemented from lemur::index::InvDocList.

virtual void lemur::index::InvFPDocList::assignElement (  lemur::api::DocInfo *  to, lemur::api::DocInfo *  from )  const [inline, protected, virtual]

copy values from one Element (of type InvFPDocInfo) to another Reimplemented from lemur::api::DocInfoList.

lemur::api::LOC_T * lemur::index::InvFPDocList::byteVec (  lemur::api::COUNT_T &  len  )

void lemur::index::InvFPDocList::deltaDecode (   )  [protected, virtual]

delta decode docids and positions from begin through end call after read Reimplemented from lemur::index::InvDocList.

void lemur::index::InvFPDocList::deltaEncode (   )  [protected, virtual]

delta encode docids and positions from begin through end call before write Reimplemented from lemur::index::InvDocList.

lemur::api::DocInfo * lemur::index::InvFPDocList::getElement (  lemur::api::DocInfo *  elem, lemur::api::POS_T  position )  const [protected, virtual]

set element from position, returns pointer to the element Reimplemented from lemur::index::InvDocList.

virtual lemur::api::DocInfo* lemur::index::InvFPDocList::newElement (   )  const [inline, protected, virtual]

create new element of this list type for the iterator Reimplemented from lemur::api::DocInfoList.

void lemur::index::InvFPDocList::nextEntry (  InvFPDocInfo *  info  )  const [virtual]

void lemur::index::InvFPDocList::nextEntry (  lemur::api::DocInfo *  info  )  const [virtual]

Reimplemented from lemur::index::InvDocList.

lemur::api::DocInfo * lemur::index::InvFPDocList::nextEntry (   )  const [virtual]

fetch the next entry, return a pointer to a local static memory, so do not delete it Reimplemented from lemur::index::InvDocList.

lemur::api::POS_T lemur::index::InvFPDocList::nextPosition (  lemur::api::POS_T  position  )  const [protected, virtual]

advance position Reimplemented from lemur::index::InvDocList.

lemur::api::COUNT_T lemur::index::InvFPDocList::termCTF (   )  const [virtual]

Reimplemented from lemur::index::InvDocList.

---

Member Data Documentation

InvFPDocInfo lemur::index::InvFPDocList::entry [mutable, private]

Reimplemented from lemur::index::InvDocList.

---

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

• InvFPDocList.hpp
• InvFPDocList.cpp

---