FirteX－高性能全文索引和检索平台

API Documentation

firtex::index::CBarrelTermDocs类参考

#include <BarrelTermDocs.h>

继承图，类firtex::index::CBarrelTermDocs


公有成员
	CBarrelTermDocs ()
	CBarrelTermDocs (CTermReader pReader, CIndexInput pDfiStream, CTermInfo &ti, CBitVector *deletedDocs)
virtual	~CBarrelTermDocs (void)
bool	seek (CTerm *term)
freq_t	docFreq ()
count_t	next (docid_t &docs, count_t &freqs)
bool	skipTo (docid_t target, docid_t &nearTarget)
bool	next ()
docid_t	doc ()
count_t	freq ()
void	close ()
保护成员
bool	decode ()
int	bsearch (docid_t docs[], int start, int end, docid_t key, docid_t &keyFound)
保护属性
CTermInfo	m_termInfo
CIndexInput *	m_pDocFreqStream
CTermReader *	m_pTermReader
CBitVector *	m_deletedDods
docid_t	m_docPage [PAGE_SIZE]
count_t	m_freqPage [PAGE_SIZE]
int	m_pageSize
int	m_length
int	m_pagePosition
int	m_docPointer
docid_t	m_lastDecodeDocID
docid_t	m_lastDocID
int	m_count

构造及析构函数文档

firtex::index::CBarrelTermDocs::CBarrelTermDocs ( )

firtex::index::CBarrelTermDocs::CBarrelTermDocs ( CTermReader * pReader,

CIndexInput * pDfiStream,

CTermInfo & ti,

CBitVector * deletedDocs

)

virtual firtex::index::CBarrelTermDocs::~CBarrelTermDocs ( void ) [virtual]

成员函数文档

int firtex::index::CBarrelTermDocs::bsearch ( docid_t docs[],

int start,

int end,

docid_t key,

docid_t & keyFound

) [inline, protected]

Binary Search
参数:

docs 文档编号数组

start 搜索起始位置

end 搜索结束位置

key 搜索键

keyFound 当搜索成功时keyFound=key,否则，返回大于key并且与key最接近的doc id, 如果key大于所有值则返回小于key且与key最接近的doc id

返回keyFound的下标

void firtex::index::CBarrelTermDocs::close ( ) [virtual]

关闭，释放资源
实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。

bool firtex::index::CBarrelTermDocs::decode ( ) [protected]

docid_t firtex::index::CBarrelTermDocs::doc ( ) [virtual]

返回当前文档编号。必须在调用next()或者skipTo(docid_t target,docid_t& nearTarget) 返回true后调用
实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。

freq_t firtex::index::CBarrelTermDocs::docFreq ( ) [inline, virtual]

获取文档频率
实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。

count_t firtex::index::CBarrelTermDocs::freq ( ) [virtual]

返回当前tf。必须在调用next()或者skipTo(docid_t target,docid_t& nearTarget) 返回true后调用
实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。

bool firtex::index::CBarrelTermDocs::next ( ) [virtual]

往前移动
返回:
当存在下一个doc时返回ture否则false

实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。

count_t firtex::index::CBarrelTermDocs::next ( docid_t *& docs,

count_t *& freqs

) [virtual]

往前移动一块
参数:

docs 文档编号数组指针

freqs tf数组指针，和docs一样大小

返回:
实际移动位置大小，实际是docs和freqs数组长度

实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。

bool firtex::index::CBarrelTermDocs::seek ( CTerm * term ) [virtual]

定位到指定term
返回:
如果找到这个term则返回true，此后可调用next获取doc freq信息，否则返回false，返回false调用next无效

实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。

bool firtex::index::CBarrelTermDocs::skipTo ( docid_t target,

docid_t & nearTarget

) [virtual]

移动到第一个文档编号大于或等于target的位置
参数:

target 目标文档编号

nearTarget 当搜索成功时nearTarget=target,否则，返回大于target并且与target最接近的doc id, 如果target大于所有值则返回小于target且与target最接近的doc id

返回:
仅当存在这样的文档编号时返回true

实现了firtex::index::CTermDocs。
被firtex::index::CBarrelTermPositions重载。