---

InvFPIndex Class Reference

#include <InvFPIndex.hpp>

Inheritance diagram for InvFPIndex:

List of all members.

Public Methods
	InvFPIndex ()
	InvFPIndex (const char *indexName)
	~InvFPIndex ()
bool	openName (char *filename)
	Open previously created Index using names in given param file, return true if opened successfully.
Open index
bool	open (const char *indexName)
	Open previously created Index with given prefix, return true if opened successfully.
Spelling and index conversion
int	term (const char *word)
	Convert a term spelling to a termID.
const char*	term (int termID)
	Convert a termID to its spelling.
int	document (const char *docIDStr)
	Convert a spelling to docID.
const char*	document (int docID)
	Convert a docID to its spelling.
Summary counts
int	docCount ()
	Total count (i.e., number) of documents in collection.
int	termCountUnique ()
	Total count of unique terms in collection.
int	termCount (int termID)const
	Total counts of a term in collection.
int	termCount ()const
	Total counts of all terms in collection.
float	docLengthAvg ()
	Average document length.
int	docCount (int termID)
	Total counts of doc with a given term.
int	docLength (DOCID_T docID)const
	Total counts of terms in a document, including stop words.
int	docLengthCounted (int docID)
	Total count of terms in given document, not including stop words.
Index entry access
DocInfoList*	docInfoList (int termID)
	doc entries in a term index, See also: DocList , InvFPDocList.
TermInfoList*	termInfoList (int docID)
	word entries in a document index (bag of words), See also: TermList.
TermInfoList*	termInfoListSeq (int docID)
	word entries in a document index (sequence of words), See also: TermList.

---

Constructor & Destructor Documentation

InvFPIndex::InvFPIndex ( )

InvFPIndex::InvFPIndex ( const char * indexName )

InvFPIndex::~InvFPIndex ( )

---

Member Function Documentation

int InvFPIndex::docCount ( int termID ) [virtual]

Total counts of doc with a given term. Reimplemented from Index.

int InvFPIndex::docCount ( ) [inline, virtual]

Total count (i.e., number) of documents in collection. Reimplemented from Index.

DocInfoList * InvFPIndex::docInfoList ( int termID ) [virtual]

doc entries in a term index, See also: DocList , InvFPDocList. Reimplemented from Index.

int InvFPIndex::docLength ( DOCID_T docID ) const

Total counts of terms in a document, including stop words.

float InvFPIndex::docLengthAvg ( ) [virtual]

Average document length. Reimplemented from Index.

int InvFPIndex::docLengthCounted ( int docID )

Total count of terms in given document, not including stop words.

const char * InvFPIndex::document ( int docID ) [virtual]

Convert a docID to its spelling. Reimplemented from Index.

int InvFPIndex::document ( const char * docIDStr ) [virtual]

Convert a spelling to docID. Reimplemented from Index.

bool InvFPIndex::open ( const char * indexName ) [virtual]

Open previously created Index with given prefix, return true if opened successfully. Reimplemented from Index.

bool InvFPIndex::openName ( char * indexName )

Open previously created Index using names in given param file, return true if opened successfully.

const char * InvFPIndex::term ( int termID ) [virtual]

Convert a termID to its spelling. Reimplemented from Index.

int InvFPIndex::term ( const char * word ) [virtual]

Convert a term spelling to a termID. Reimplemented from Index.

int InvFPIndex::termCount ( ) const [inline, virtual]

Total counts of all terms in collection. Reimplemented from Index.

int InvFPIndex::termCount ( int termID ) const [virtual]

Total counts of a term in collection. Reimplemented from Index.

int InvFPIndex::termCountUnique ( ) [inline, virtual]

Total count of unique terms in collection. Reimplemented from Index.

TermInfoList * InvFPIndex::termInfoList ( int docID ) [virtual]

word entries in a document index (bag of words), See also: TermList. Reimplemented from Index.

TermInfoList * InvFPIndex::termInfoListSeq ( int docID )

word entries in a document index (sequence of words), See also: TermList.

---

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

• InvFPIndex.hpp
• InvFPIndex.cpp

---