---

ProxInfo Class Reference

#include <ProxInfo.hpp>

List of all members.

Public Methods
	ProxInfo ()
	Make an empty one.
	ProxInfo::ProxInfo (int num, int tf, const DocInfoList *dl)
	Make one from an InvFPDocList.
	ProxInfo (int num, int tf, LOC_T *pl)
	Make one from a doc positions list.
	~ProxInfo ()
	clean up.
int	id () const
	document id of current entry
COUNT_T	count () const
	term freq of current entry
const LOC_T *	positions () const
	positions array of current entry
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 (DOCID_T did)
int	posSize () const
	how long is the list of positions for all docs.
Public Attributes
int	size
	window size
int	nextPos

---

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

ProxInfo::ProxInfo (    )  [inline]

Make an empty one.

ProxInfo::ProxInfo (  int    num, int    tf, LOC_T *    pl )

Make one from a doc positions list.

ProxInfo::~ProxInfo (    )  [inline]

clean up.

---

Member Function Documentation

COUNT_T ProxInfo::count (    )  const [inline]

term freq of current entry

bool ProxInfo::hasMore (    )  [inline]

have any more?

int ProxInfo::id (    )  const [inline]

document id of current entry

bool ProxInfo::nextDoc (  DOCID_T    did )

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

bool ProxInfo::nextDoc (    )

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

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

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

const LOC_T* ProxInfo::positions (    )  const [inline]

positions array of current entry

int ProxInfo::posSize (    )

how long is the list of positions for all docs.

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

Make one from an InvFPDocList.

void ProxInfo::startIteration (    )  [inline]

Iteration support (restartable).

---

Member Data Documentation

int ProxInfo::nextPos

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

int ProxInfo::size

window size

---

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

• ProxInfo.hpp
• ProxInfo.cpp

---