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

API Documentation

firtex::index::CBarrelTermPositions类参考

#include <BarrelTermPositions.h>

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


公有成员
	CBarrelTermPositions (void)
	CBarrelTermPositions (CTermReader pReader, CIndexInput pDfiStream, CIndexInput pPtiStream, CTermInfo &ti, CBitVector deletedDocs)
virtual	~CBarrelTermPositions (void)
bool	seek (CTerm *term)
docid_t	doc ()
count_t	freq ()
bool	next ()
count_t	next (docid_t &docs, count_t &freqs)
bool	skipTo (docid_t target, docid_t &nearTarget)
bool	skipToPosition (loc_t target, loc_t &nearTarget)
freq_t	docFreq ()
void	close ()
loc_t	nextPosition ()
count_t	nextPositions (loc_t *&positions)
保护成员
bool	decodePositions ()
保护属性
int	m_posCount
int	m_posPointer
int	m_posPageSize
int	m_posLength
int	m_posPagePosition
int	m_posDecodeCount
loc_t	m_posPage [PAGE_SIZE]
loc_t	m_posLastPos
CIndexInput *	m_pPosStream

构造及析构函数文档

firtex::index::CBarrelTermPositions::CBarrelTermPositions ( void )

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

CIndexInput * pDfiStream,

CIndexInput * pPtiStream,

CTermInfo & ti,

CBitVector * deletedDocs

)

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

成员函数文档

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

关闭，释放资源
重载firtex::index::CBarrelTermDocs。

bool firtex::index::CBarrelTermPositions::decodePositions ( ) [protected]

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

返回当前文档编号。在第一次没有调用next之前调用无效
重载firtex::index::CBarrelTermDocs。

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

获取文档频率
重载firtex::index::CBarrelTermDocs。

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

返回当前tf。在第一次没有调用next之前调用无效
重载firtex::index::CBarrelTermDocs。

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

count_t *& freqs

) [virtual]

往前移动一块
参数:

docs 文档编号数组指针

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

count 移动块大小

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

重载firtex::index::CBarrelTermDocs。

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

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

重载firtex::index::CBarrelTermDocs。

loc_t firtex::index::CBarrelTermPositions::nextPosition ( ) [virtual]

下一个位置
实现了firtex::index::CTermPositions。

count_t firtex::index::CBarrelTermPositions::nextPositions ( loc_t *& positions ) [virtual]

下一块位置
参数:

positions 位置数组

返回:
实际位置个数，positions数组大小

实现了firtex::index::CTermPositions。

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

定位到指定term
重载firtex::index::CBarrelTermDocs。

bool firtex::index::CBarrelTermPositions::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::CBarrelTermDocs。

bool firtex::index::CBarrelTermPositions::skipToPosition ( loc_t target,

loc_t & nearTarget

) [virtual]

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

target 目标位置

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

返回:
仅当存在target位置时返回true

实现了firtex::index::CTermPositions。