---

InvFPDocList Class Reference

#include <InvFPDocList.hpp>

Inheritance diagram for InvFPDocList:

List of all members.

Public Methods
	InvFPDocList ()
	InvFPDocList (LOC_T *vec)
	copy from byteVector
	InvFPDocList (TERMID_T id, int len)
	InvFPDocList (MemCache *mc, TERMID_T id, int len)
	constructors for this list getting memory from a MemCache
	InvFPDocList (MemCache *mc, TERMID_T id, int len, DOCID_T docid, LOC_T location)
	InvFPDocList (TERMID_T id, int listlen, LOC_T *list, int fr, DOCID_T *ldocid, int len)
	constructor for a list not needing to get any memory
	~InvFPDocList ()
bool	addTerm (DOCID_T docid)
	increase count for this docid, we don't care about location
bool	addLocation (DOCID_T docid, 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 DocInfo *	nextEntry () const
	fetch the next entry, return a pointer to a local static memory, so do not delete it
virtual void	nextEntry (InvFPDocInfo *info) const
virtual COUNT_T	termCTF () const
LOC_T *	byteVec (COUNT_T &len)
Protected Methods
virtual DocInfo *	newElement () const
	create new element of this list type for the iterator
virtual DocInfo *	getElement (DocInfo *elem, POS_T position) const
	set element from position, returns pointer to the element
virtual void	assignElement (DocInfo *to, DocInfo *from) const
	copy values from one Element (of type InvFPDocInfo) to another
virtual POS_T	nextPosition (POS_T position) const
	advance position
virtual void	deltaEncode ()
virtual void	deltaDecode ()

---

Constructor & Destructor Documentation

InvFPDocList::InvFPDocList (    )

InvFPDocList::InvFPDocList (  LOC_T *    vec )

copy from byteVector

InvFPDocList::InvFPDocList (  TERMID_T    id, int    len )

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

InvFPDocList::InvFPDocList (  MemCache *    mc, TERMID_T    id, int    len )

constructors for this list getting memory from a MemCache

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

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

constructor for a list not needing to get any memory

InvFPDocList::~InvFPDocList (    )

---

Member Function Documentation

bool InvFPDocList::addLocation (  DOCID_T    docid, LOC_T    location )

bool InvFPDocList::addTerm (  DOCID_T    docid )  [virtual]

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

bool 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 InvDocList.

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

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

LOC_T * InvFPDocList::byteVec (  COUNT_T &    len )

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

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

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

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

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

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

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

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

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

DocInfo * InvFPDocList::nextEntry (    )  [virtual]

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

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

advance position Reimplemented from InvDocList.

COUNT_T InvFPDocList::termCTF (    )  [virtual]

Reimplemented from InvDocList.

---

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

• InvFPDocList.hpp
• InvFPDocList.cpp

---