classxapian_1_1termiterator.tex

xapian 是一个“Xapian 是一个开源概率论信息检索库

\hypertarget{classXapian_1_1TermIterator}{
\section{Xapian::Term\-Iterator Class Reference}
\label{classXapian_1_1TermIterator}\index{Xapian::TermIterator@{Xapian::TermIterator}}
}
An iterator pointing to items in a list of terms.  


{\tt \#include $<$termiterator.h$>$}

Collaboration diagram for Xapian::Term\-Iterator:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=119pt]{classXapian_1_1TermIterator__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{Indent}{\bf }\par
\begin{CompactItemize}
\item 
typedef std::input\_\-iterator\_\-tag \hyperlink{classXapian_1_1TermIterator_feab33f745f72c8e9c24a58fe1e25800}{iterator\_\-category}
\begin{CompactList}\small\item\em Allow use as an STL iterator. \item\end{CompactList}\item 
\hypertarget{classXapian_1_1TermIterator_1f80825c29a2d6e16f3d4008cedb7833}{
typedef std::string {\bf value\_\-type}}
\label{classXapian_1_1TermIterator_1f80825c29a2d6e16f3d4008cedb7833}

\item 
\hypertarget{classXapian_1_1TermIterator_2caca0d976af5309003b95e66cbebe73}{
typedef \hyperlink{types_8h_992fbdbe6bdbfc25fb14ffcd6a83692a}{Xapian::termcount\_\-diff} {\bf difference\_\-type}}
\label{classXapian_1_1TermIterator_2caca0d976af5309003b95e66cbebe73}

\item 
\hypertarget{classXapian_1_1TermIterator_c674b6f574ee46bb6725c0fd41d06fc2}{
typedef std::string $\ast$ {\bf pointer}}
\label{classXapian_1_1TermIterator_c674b6f574ee46bb6725c0fd41d06fc2}

\item 
\hypertarget{classXapian_1_1TermIterator_32f947d758ed204f39f099487412a878}{
typedef std::string \& {\bf reference}}
\label{classXapian_1_1TermIterator_32f947d758ed204f39f099487412a878}

\end{CompactItemize}
\end{Indent}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1TermIterator_cab902a436d816b02ac90f79ef783022}{
{\bf Term\-Iterator} (Internal $\ast$internal\_\-)}
\label{classXapian_1_1TermIterator_cab902a436d816b02ac90f79ef783022}

\item 
\hyperlink{classXapian_1_1TermIterator_fd50fb35c84e433fc3762447e28b4bab}{Term\-Iterator} ()
\begin{CompactList}\small\item\em Default constructor - for declaring an uninitialised iterator. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1TermIterator_914de6019011c9c25b00e84f556af681}{$\sim$Term\-Iterator} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1TermIterator_25c1623d9275a88c8a061d1f19b36296}{Term\-Iterator} (const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \&other)
\begin{CompactList}\small\item\em Copying is allowed. \item\end{CompactList}\item 
void \hyperlink{classXapian_1_1TermIterator_feb284448d65b6e86914c552808938df}{operator=} (const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \&other)
\begin{CompactList}\small\item\em Assignment is allowed. \item\end{CompactList}\item 
std::string \hyperlink{classXapian_1_1TermIterator_0128ca7bb242f5ccba19ab3a42a4deff}{operator $\ast$} () const 
\begin{CompactList}\small\item\em Return the current term. \item\end{CompactList}\item 
\hypertarget{classXapian_1_1TermIterator_04d4db66b44b0e948f8cd925130aacb0}{
\hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \& {\bf operator++} ()}
\label{classXapian_1_1TermIterator_04d4db66b44b0e948f8cd925130aacb0}

\item 
\hypertarget{classXapian_1_1TermIterator_7ebfd4ac90e1bdeb34e3dfec2cc9ea80}{
\hyperlink{classXapian_1_1TermNameWrapper}{Term\-Name\-Wrapper} {\bf operator++} (int)}
\label{classXapian_1_1TermIterator_7ebfd4ac90e1bdeb34e3dfec2cc9ea80}

\item 
void \hyperlink{classXapian_1_1TermIterator_3b0a7bdae1ac63ee187fa2063d7aeb35}{skip\_\-to} (const std::string \&tname)
\begin{CompactList}\small\item\em Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated. \item\end{CompactList}\item 
\hyperlink{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}{Xapian::termcount} \hyperlink{classXapian_1_1TermIterator_aad6e6fcfc9ffb513cef923b65adf6e8}{get\_\-wdf} () const 
\begin{CompactList}\small\item\em Return the wdf of the current term (if meaningful). \item\end{CompactList}\item 
\hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{Xapian::doccount} \hyperlink{classXapian_1_1TermIterator_68adffacecf143bdafafdb35ecac8511}{get\_\-termfreq} () const 
\begin{CompactList}\small\item\em Return the term frequency of the current term (if meaningful). \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \hyperlink{classXapian_1_1TermIterator_c5cae68c58a8f405721732529d2144d6}{positionlist\_\-begin} () const 
\begin{CompactList}\small\item\em Return \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} pointing to start of positionlist for current term. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \hyperlink{classXapian_1_1TermIterator_68a6157a501e51b7043ba86676be026f}{positionlist\_\-end} () const 
\begin{CompactList}\small\item\em Return \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} pointing to end of positionlist for current term. \item\end{CompactList}\item 
std::string \hyperlink{classXapian_1_1TermIterator_9a7aeca02e3c4dc43d7553f6a0c19abf}{get\_\-description} () const 
\begin{CompactList}\small\item\em Returns a string describing this object. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1TermIterator_812a032d52a8b003274459efb040e3e7}{
\hyperlink{classXapian_1_1Internal_1_1RefCntPtr}{Xapian::Internal::Ref\-Cnt\-Ptr}$<$ Internal $>$ {\bf internal}}
\label{classXapian_1_1TermIterator_812a032d52a8b003274459efb040e3e7}

\end{CompactItemize}


\subsection{Detailed Description}
An iterator pointing to items in a list of terms. 



\subsection{Member Typedef Documentation}
\hypertarget{classXapian_1_1TermIterator_feab33f745f72c8e9c24a58fe1e25800}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!iterator_category@{iterator\_\-category}}
\index{iterator_category@{iterator\_\-category}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[iterator\_\-category]{\setlength{\rightskip}{0pt plus 5cm}typedef std::input\_\-iterator\_\-tag \hyperlink{classXapian_1_1TermIterator_feab33f745f72c8e9c24a58fe1e25800}{Xapian::Term\-Iterator::iterator\_\-category}}}
\label{classXapian_1_1TermIterator_feab33f745f72c8e9c24a58fe1e25800}


Allow use as an STL iterator. 



\subsection{Constructor \& Destructor Documentation}
\hypertarget{classXapian_1_1TermIterator_fd50fb35c84e433fc3762447e28b4bab}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!TermIterator@{TermIterator}}
\index{TermIterator@{TermIterator}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[TermIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Term\-Iterator::Term\-Iterator ()}}
\label{classXapian_1_1TermIterator_fd50fb35c84e433fc3762447e28b4bab}


Default constructor - for declaring an uninitialised iterator. 

\hypertarget{classXapian_1_1TermIterator_914de6019011c9c25b00e84f556af681}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!~TermIterator@{$\sim$TermIterator}}
\index{~TermIterator@{$\sim$TermIterator}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[$\sim$TermIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Term\-Iterator::$\sim$Term\-Iterator ()}}
\label{classXapian_1_1TermIterator_914de6019011c9c25b00e84f556af681}


Destructor. 

\hypertarget{classXapian_1_1TermIterator_25c1623d9275a88c8a061d1f19b36296}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!TermIterator@{TermIterator}}
\index{TermIterator@{TermIterator}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[TermIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Term\-Iterator::Term\-Iterator (const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \& {\em other})}}
\label{classXapian_1_1TermIterator_25c1623d9275a88c8a061d1f19b36296}


Copying is allowed. 

The internals are reference counted, so copying is also cheap. 

\subsection{Member Function Documentation}
\hypertarget{classXapian_1_1TermIterator_9a7aeca02e3c4dc43d7553f6a0c19abf}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!get_description@{get\_\-description}}
\index{get_description@{get\_\-description}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[get\_\-description]{\setlength{\rightskip}{0pt plus 5cm}std::string Xapian::Term\-Iterator::get\_\-description () const}}
\label{classXapian_1_1TermIterator_9a7aeca02e3c4dc43d7553f6a0c19abf}


Returns a string describing this object. 

Introspection method. \hypertarget{classXapian_1_1TermIterator_68adffacecf143bdafafdb35ecac8511}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!get_termfreq@{get\_\-termfreq}}
\index{get_termfreq@{get\_\-termfreq}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[get\_\-termfreq]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{Xapian::doccount} Xapian::Term\-Iterator::get\_\-termfreq () const}}
\label{classXapian_1_1TermIterator_68adffacecf143bdafafdb35ecac8511}


Return the term frequency of the current term (if meaningful). 

\hypertarget{classXapian_1_1TermIterator_aad6e6fcfc9ffb513cef923b65adf6e8}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!get_wdf@{get\_\-wdf}}
\index{get_wdf@{get\_\-wdf}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[get\_\-wdf]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}{Xapian::termcount} Xapian::Term\-Iterator::get\_\-wdf () const}}
\label{classXapian_1_1TermIterator_aad6e6fcfc9ffb513cef923b65adf6e8}


Return the wdf of the current term (if meaningful). 

\hypertarget{classXapian_1_1TermIterator_0128ca7bb242f5ccba19ab3a42a4deff}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!operator *@{operator $\ast$}}
\index{operator *@{operator $\ast$}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[operator $\ast$]{\setlength{\rightskip}{0pt plus 5cm}std::string Xapian::Term\-Iterator::operator $\ast$ () const}}
\label{classXapian_1_1TermIterator_0128ca7bb242f5ccba19ab3a42a4deff}


Return the current term. 

\hypertarget{classXapian_1_1TermIterator_feb284448d65b6e86914c552808938df}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!operator=@{operator=}}
\index{operator=@{operator=}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[operator=]{\setlength{\rightskip}{0pt plus 5cm}void Xapian::Term\-Iterator::operator= (const \hyperlink{classXapian_1_1TermIterator}{Term\-Iterator} \& {\em other})}}
\label{classXapian_1_1TermIterator_feb284448d65b6e86914c552808938df}


Assignment is allowed. 

The internals are reference counted, so assignment is also cheap. \hypertarget{classXapian_1_1TermIterator_c5cae68c58a8f405721732529d2144d6}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!positionlist_begin@{positionlist\_\-begin}}
\index{positionlist_begin@{positionlist\_\-begin}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[positionlist\_\-begin]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} Xapian::Term\-Iterator::positionlist\_\-begin () const}}
\label{classXapian_1_1TermIterator_c5cae68c58a8f405721732529d2144d6}


Return \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} pointing to start of positionlist for current term. 

\hypertarget{classXapian_1_1TermIterator_68a6157a501e51b7043ba86676be026f}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!positionlist_end@{positionlist\_\-end}}
\index{positionlist_end@{positionlist\_\-end}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[positionlist\_\-end]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} Xapian::Term\-Iterator::positionlist\_\-end () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1TermIterator_68a6157a501e51b7043ba86676be026f}


Return \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} pointing to end of positionlist for current term. 

\hypertarget{classXapian_1_1TermIterator_3b0a7bdae1ac63ee187fa2063d7aeb35}{
\index{Xapian::TermIterator@{Xapian::Term\-Iterator}!skip_to@{skip\_\-to}}
\index{skip_to@{skip\_\-to}!Xapian::TermIterator@{Xapian::Term\-Iterator}}
\subsubsection[skip\_\-to]{\setlength{\rightskip}{0pt plus 5cm}void Xapian::Term\-Iterator::skip\_\-to (const std::string \& {\em tname})}}
\label{classXapian_1_1TermIterator_3b0a7bdae1ac63ee187fa2063d7aeb35}


Skip the iterator to term tname, or the first term after tname if tname isn't in the list of terms being iterated. 



The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
include/xapian/\hyperlink{termiterator_8h}{termiterator.h}\end{CompactItemize}