lemur::retrieval::ProxInfo Class Reference

Proximity information for a term within a document. More...

#include <ProxInfo.hpp>

List of all members.

Public Member Functions
	ProxInfo ()
	Make an empty one.
	ProxInfo (int num, int tf, const lemur::api::DocInfoList *dl)
	Make one from an InvFPDocList.
	ProxInfo (int num, int tf, lemur::api::LOC_T *pl)
	Make one from a doc positions list.
	~ProxInfo ()
	clean up.
int	id () const
	document id of current entry
lemur::api::COUNT_T	count () const
	term freq of current entry
const lemur::api::LOC_T *	positions () const
	positions array of current entry
lemur::api::LOC_T	position (int k) const
void	startIteration ()
	Iteration support (restartable).
bool	hasMore ()
	have any more?
bool	nextDoc ()
	Advance to next document, return false if no more docs.
bool	nextDoc (lemur::api::DOCID_T did)
int	posSize () const
	how long is the list of positions for all docs.
Public Attributes
int	size
	window size
int	nextPos
Private Attributes
lemur::api::LOC_T *	posList
	list of positions in document for operators
const lemur::index::InvFPDocList *	dList
	contains list of positions in document for terms
lemur::index::InvFPDocInfo	currEntry
int	listSize

---

Detailed Description

Proximity information for a term within a document.

Provides support for ordered and unordered window operators. Used to prune document lists before scoring the documents.

---

Constructor & Destructor Documentation

lemur::retrieval::ProxInfo::ProxInfo (   )  [inline]

Make an empty one.

lemur::retrieval::ProxInfo::ProxInfo (  int  num, int  tf, const lemur::api::DocInfoList *  dl )

Make one from an InvFPDocList.

lemur::retrieval::ProxInfo::ProxInfo (  int  num, int  tf, lemur::api::LOC_T *  pl )

Make one from a doc positions list.

lemur::retrieval::ProxInfo::~ProxInfo (   )  [inline]

clean up.

---

Member Function Documentation

lemur::api::COUNT_T lemur::retrieval::ProxInfo::count (   )  const [inline]

term freq of current entry

bool lemur::retrieval::ProxInfo::hasMore (   )  [inline]

have any more?

int lemur::retrieval::ProxInfo::id (   )  const [inline]

document id of current entry

bool lemur::retrieval::ProxInfo::nextDoc (  lemur::api::DOCID_T  did  )

Advance to document did, return false if not in list and stop on next doc after did.

bool lemur::retrieval::ProxInfo::nextDoc (   )

Advance to next document, return false if no more docs.

lemur::api::LOC_T lemur::retrieval::ProxInfo::position (  int  k  )  const [inline]

return position value at index k in the current entry's position list

const lemur::api::LOC_T* lemur::retrieval::ProxInfo::positions (   )  const [inline]

positions array of current entry

int lemur::retrieval::ProxInfo::posSize (   )  const

how long is the list of positions for all docs.

void lemur::retrieval::ProxInfo::startIteration (   )  [inline]

Iteration support (restartable).

---

Member Data Documentation

lemur::index::InvFPDocInfo lemur::retrieval::ProxInfo::currEntry [private]

const lemur::index::InvFPDocList* lemur::retrieval::ProxInfo::dList [private]

contains list of positions in document for terms

int lemur::retrieval::ProxInfo::listSize [private]

int lemur::retrieval::ProxInfo::nextPos

next position of this term in document used by unordered window // unneeded?

lemur::api::LOC_T* lemur::retrieval::ProxInfo::posList [private]

list of positions in document for operators

int lemur::retrieval::ProxInfo::size

window size

---

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

• ProxInfo.hpp
• ProxInfo.cpp

---