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

API Documentation

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

firtex::index::CTermFreqVector类参考

#include <TermFreqVector.h>

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

firtex::index::CTermPositionVector firtex::index::CWordFreqVector firtex::index::CWordPositionVector 所有成员的列表。

公有成员

 CTermFreqVector (void)
 CTermFreqVector (const tchar *field)
virtual ~CTermFreqVector (void)
virtual void open (const tchar *field, CIndexInput *pInput)=0
virtual const tchar * getField ()
virtual count_t numTerms ()=0
virtual count_t numDistinctTerms ()=0
virtual const CTerm * getTerms ()=0
virtual const termid_t * getTermIDs ()=0
virtual const freq_t * getTermFrequencies ()=0
virtual void getTermFreqVector (termid_t *&tids, freq_t *&freqs, count_t &size)=0
virtual int indexOf (termid_t tid)=0

保护成员

virtual void addField (CIndexOutput *pOutput, CField *pField)=0

保护属性

CFXString m_field

友元

class CTermVectorWriter

构造及析构函数文档

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

firtex::index::CTermFreqVector::CTermFreqVector (  const tchar *  field  )  [inline]
 

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

成员函数文档

virtual void firtex::index::CTermFreqVector::addField (  CIndexOutput *  pOutput,
CField *  pField
)  [protected, pure virtual]
 

添加字段，建立字段的前向索引，供CTermVectorWriter调用，外部不能直接使用

参数:
pOutput 前向索引的输出设备
pField 字段对象指针

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual const tchar* firtex::index::CTermFreqVector::getField (   )  [inline, virtual]
 

获取关联的字段名

virtual const freq_t* firtex::index::CTermFreqVector::getTermFrequencies (   )  [pure virtual]
 

获取词频数组,数组大小与numDistinctTerms返回的数值一致

返回:
词频数组 返回内部的数组指针,外部不要删除

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual void firtex::index::CTermFreqVector::getTermFreqVector (  termid_t *&  tids,
freq_t *&  freqs,
count_t &  size
)  [pure virtual]
 

获取词向量

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual const termid_t* firtex::index::CTermFreqVector::getTermIDs (   )  [pure virtual]
 

获取词ID数组，数组大小与numDistinctTerms返回的数值一致

返回:
数组指针 返回内部的数组指针，外部不要删除

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual const CTerm* firtex::index::CTermFreqVector::getTerms (   )  [pure virtual]
 

获取词数组，数组大小与numDistinctTerms返回的数值一致

返回:
Term数组指针 返回内部的数组指针,外部不要删除

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual int firtex::index::CTermFreqVector::indexOf (  termid_t  tid  )  [pure virtual]
 

获取词tid在getTermIDs返回的数组中的下标

参数:
tid 词ID
返回:
下标,如果tid没有出现则返回-1

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual count_t firtex::index::CTermFreqVector::numDistinctTerms (   )  [pure virtual]
 

获取非重复词总数

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual count_t firtex::index::CTermFreqVector::numTerms (   )  [pure virtual]
 

获取总词数

在firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

virtual void firtex::index::CTermFreqVector::open (  const tchar *  field,
CIndexInput *  pInput
)  [pure virtual]
 

打开Term Vector，准备读取Term Vector 信息

参数:
field 字段名
pInput 读取位置,不作为内部对象,内部将克隆一份

在firtex::index::CTermPositionVector、firtex::index::CWordFreqVector及firtex::index::CWordPositionVector内被实现。

友元及相关函数文档

friend class CTermVectorWriter [friend]
 

成员数据文档

CFXString firtex::index::CTermFreqVector::m_field [protected]
 

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

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