---

ProxInfo Class Reference

#include <ProxInfo.hpp>

List of all members.

Public Methods
	ProxInfo ()
	Make an empty one.
	ProxInfo::ProxInfo (int num, int tf, DocInfoList *dl)
	Make one from a DocInfoList.
	ProxInfo (int num, int tf, int *pl)
	Make one from a doc positions list.
	~ProxInfo ()
	clean up.
int	id ()
	document id of current entry
int	count ()
	term freq of current entry
int *	positions ()
	positions array of current entry
int	position (int k)
void	startIteration ()
	Iteration support (restartable).
bool	hasMore ()
	have any more?
bool	nextDoc ()
	Advance to next document, return false if no more docs.
bool	nextDoc (int did)
int	posSize ()
	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, int *    pl )

Make one from a doc positions list.

ProxInfo::~ProxInfo (    )  [inline]

clean up.

---

Member Function Documentation

int ProxInfo::count (    )  [inline]

term freq of current entry

bool ProxInfo::hasMore (    )  [inline]

have any more?

int ProxInfo::id (    )  [inline]

document id of current entry

bool ProxInfo::nextDoc (  int    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.

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

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

int* ProxInfo::positions (    )  [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, DocInfoList *    dl )  [inline]

Make one from a DocInfoList.

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

---