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

API Documentation

首页 | 名字空间列表 | 类继承关系 | 组合类型列表 | $(BL\录(B | 文件列表 | 名字空间成员 | 组合类型成员 | 文件成员

firtex::index::CTermDocs类参考

#include <TermDocs.h>

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

firtex::index::CBarrelTermDocs firtex::index::CMultiTermDocs firtex::index::CTermPositions firtex::index::CBarrelTermPositions firtex::index::CBarrelTermPositions firtex::index::CMultiTermPositions 所有成员的列表。

公有成员

 CTermDocs (void)
virtual ~CTermDocs (void)
virtual bool seek (CTerm *term)=0
virtual freq_t docFreq ()=0
virtual count_t next (docid_t *&docs, count_t *&freqs)=0
virtual bool skipTo (docid_t target, docid_t &nearTarget)=0
virtual bool next ()=0
virtual docid_t doc ()=0
virtual count_t freq ()=0
virtual void close ()=0

构造及析构函数文档

firtex::index::CTermDocs::CTermDocs (  void   )  [inline]
 

virtual firtex::index::CTermDocs::~CTermDocs (  void   )  [inline, virtual]
 

成员函数文档

virtual void firtex::index::CTermDocs::close (   )  [pure virtual]
 

关闭，释放资源

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

virtual docid_t firtex::index::CTermDocs::doc (   )  [pure virtual]
 

返回当前文档编号。必须在调用next()或者skipTo(docid_t target,docid_t& nearTarget) 返回true后调用

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

virtual freq_t firtex::index::CTermDocs::docFreq (   )  [pure virtual]
 

获取文档频率

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

virtual count_t firtex::index::CTermDocs::freq (   )  [pure virtual]
 

返回当前tf。必须在调用next()或者skipTo(docid_t target,docid_t& nearTarget) 返回true后调用

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

virtual bool firtex::index::CTermDocs::next (   )  [pure virtual]
 

往前移动

返回:
当存在下一个term时返回ture否则false

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

virtual count_t firtex::index::CTermDocs::next (  docid_t *&  docs,
count_t *&  freqs
)  [pure virtual]
 

往前移动一块

参数:
docs 文档编号数组指针
freqs tf数组指针，和docs一样大小
返回:
实际移动位置大小，实际是docs和freqs数组长度

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

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

定位到指定term

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

virtual bool firtex::index::CTermDocs::skipTo (  docid_t  target,
docid_t &  nearTarget
)  [pure virtual]
 

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

参数:
target 目标文档编号
nearTarget 当搜索成功时nearTarget=target,否则，返回大于target并且与target最接近的doc id, 如果target大于所有值则返回小于target且与target最接近的doc id
返回:
仅当存在这样的文档编号时返回true

在firtex::index::CBarrelTermDocs、firtex::index::CBarrelTermPositions、firtex::index::CMultiTermDocs及firtex::index::CMultiTermPositions内被实现。

该类的文档由以下文件生成：

http://www.firtex.org http://www.sourceforge.net/projects/firtex