classxapian_1_1positioniterator.tex

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

\hypertarget{classXapian_1_1PositionIterator}{
\section{Xapian::Position\-Iterator Class Reference}
\label{classXapian_1_1PositionIterator}\index{Xapian::PositionIterator@{Xapian::PositionIterator}}
}
An iterator pointing to items in a list of positions.  


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

Collaboration diagram for Xapian::Position\-Iterator:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=119pt]{classXapian_1_1PositionIterator__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1PositionIterator_dded3bc4a76ffedeb7609564463035fe}{
typedef std::input\_\-iterator\_\-tag {\bf iterator\_\-category}}
\label{classXapian_1_1PositionIterator_dded3bc4a76ffedeb7609564463035fe}

\item 
\hypertarget{classXapian_1_1PositionIterator_c4741dab3be0505772a23b74b9779be1}{
typedef \hyperlink{types_8h_5cdae0172ef811a7c08017eb4429c311}{Xapian::termpos} {\bf value\_\-type}}
\label{classXapian_1_1PositionIterator_c4741dab3be0505772a23b74b9779be1}

\item 
\hypertarget{classXapian_1_1PositionIterator_15d4f82622935bd22e4f8a00eb5441e3}{
typedef \hyperlink{types_8h_800ebcc9f3f0de991f2755f28cca8ea7}{Xapian::termpos\_\-diff} {\bf difference\_\-type}}
\label{classXapian_1_1PositionIterator_15d4f82622935bd22e4f8a00eb5441e3}

\item 
\hypertarget{classXapian_1_1PositionIterator_f54eec4f7538018aa15e429717a9a776}{
typedef \hyperlink{types_8h_5cdae0172ef811a7c08017eb4429c311}{Xapian::termpos} $\ast$ {\bf pointer}}
\label{classXapian_1_1PositionIterator_f54eec4f7538018aa15e429717a9a776}

\item 
\hypertarget{classXapian_1_1PositionIterator_78150a5bac9b31089d075e8b93404a2d}{
typedef \hyperlink{types_8h_5cdae0172ef811a7c08017eb4429c311}{Xapian::termpos} \& {\bf reference}}
\label{classXapian_1_1PositionIterator_78150a5bac9b31089d075e8b93404a2d}

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

\item 
\hyperlink{classXapian_1_1PositionIterator_475e11e82d8268d23b750c787531ab9a}{Position\-Iterator} ()
\begin{CompactList}\small\item\em Default constructor - for declaring an uninitialised iterator. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PositionIterator_9a84f5de9867d1413c0dacb704d63c04}{$\sim$Position\-Iterator} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PositionIterator_8b9d10db35fa9e2944012ea57a0b9d23}{Position\-Iterator} (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&o)
\begin{CompactList}\small\item\em Copying is allowed. \item\end{CompactList}\item 
void \hyperlink{classXapian_1_1PositionIterator_5cbc03e21296bb5347736977d0f27547}{operator=} (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&o)
\begin{CompactList}\small\item\em Assignment is allowed. \item\end{CompactList}\item 
\hypertarget{classXapian_1_1PositionIterator_c1192e397c4c731bcfddc9cb54ad7f6c}{
\hyperlink{types_8h_5cdae0172ef811a7c08017eb4429c311}{Xapian::termpos} {\bf operator $\ast$} () const }
\label{classXapian_1_1PositionIterator_c1192e397c4c731bcfddc9cb54ad7f6c}

\item 
\hypertarget{classXapian_1_1PositionIterator_f4a068fa03b75f797ab4cae83fc0810f}{
\hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \& {\bf operator++} ()}
\label{classXapian_1_1PositionIterator_f4a068fa03b75f797ab4cae83fc0810f}

\item 
\hypertarget{classXapian_1_1PositionIterator_72256efd651056af51d61b8822b4b6c5}{
\hyperlink{classXapian_1_1TermPosWrapper}{Term\-Pos\-Wrapper} {\bf operator++} (int)}
\label{classXapian_1_1PositionIterator_72256efd651056af51d61b8822b4b6c5}

\item 
\hypertarget{classXapian_1_1PositionIterator_5ecfb4a9c90777b64368c8f61b26e296}{
void {\bf skip\_\-to} (\hyperlink{types_8h_5cdae0172ef811a7c08017eb4429c311}{Xapian::termpos} pos)}
\label{classXapian_1_1PositionIterator_5ecfb4a9c90777b64368c8f61b26e296}

\item 
std::string \hyperlink{classXapian_1_1PositionIterator_ae9e6e3e7481bd22f228de4c2deb03eb}{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_1PositionIterator_19560cd05a63bfcdf47a3ee46753a25b}{
\hyperlink{classXapian_1_1Internal_1_1RefCntPtr}{Xapian::Internal::Ref\-Cnt\-Ptr}$<$ Internal $>$ {\bf internal}}
\label{classXapian_1_1PositionIterator_19560cd05a63bfcdf47a3ee46753a25b}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1PositionIterator_3793c7cf3235df63c311d80fe57184ed}{
class {\bf Posting\-Iterator}}
\label{classXapian_1_1PositionIterator_3793c7cf3235df63c311d80fe57184ed}

\item 
\hypertarget{classXapian_1_1PositionIterator_4a5b37fd898d58b54a11a528a1343e1e}{
class {\bf Term\-Iterator}}
\label{classXapian_1_1PositionIterator_4a5b37fd898d58b54a11a528a1343e1e}

\item 
\hypertarget{classXapian_1_1PositionIterator_6efef52d7a939622bbc934ff6b90ffe0}{
class {\bf Database}}
\label{classXapian_1_1PositionIterator_6efef52d7a939622bbc934ff6b90ffe0}

\item 
bool \hyperlink{classXapian_1_1PositionIterator_834fe2a9af5f7e592e1ceaba44ceb1a3}{operator==} (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&a, const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \&b)
\begin{CompactList}\small\item\em Test equality of two Position\-Iterators. \item\end{CompactList}\end{CompactItemize}


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



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


Default constructor - for declaring an uninitialised iterator. 

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


Destructor. 

\hypertarget{classXapian_1_1PositionIterator_8b9d10db35fa9e2944012ea57a0b9d23}{
\index{Xapian::PositionIterator@{Xapian::Position\-Iterator}!PositionIterator@{PositionIterator}}
\index{PositionIterator@{PositionIterator}!Xapian::PositionIterator@{Xapian::Position\-Iterator}}
\subsubsection[PositionIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Position\-Iterator::Position\-Iterator (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \& {\em o})}}
\label{classXapian_1_1PositionIterator_8b9d10db35fa9e2944012ea57a0b9d23}


Copying is allowed. 

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

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


Returns a string describing this object. 

Introspection method. \hypertarget{classXapian_1_1PositionIterator_5cbc03e21296bb5347736977d0f27547}{
\index{Xapian::PositionIterator@{Xapian::Position\-Iterator}!operator=@{operator=}}
\index{operator=@{operator=}!Xapian::PositionIterator@{Xapian::Position\-Iterator}}
\subsubsection[operator=]{\setlength{\rightskip}{0pt plus 5cm}void Xapian::Position\-Iterator::operator= (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \& {\em o})}}
\label{classXapian_1_1PositionIterator_5cbc03e21296bb5347736977d0f27547}


Assignment is allowed. 

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

\subsection{Friends And Related Function Documentation}
\hypertarget{classXapian_1_1PositionIterator_834fe2a9af5f7e592e1ceaba44ceb1a3}{
\index{Xapian::PositionIterator@{Xapian::Position\-Iterator}!operator==@{operator==}}
\index{operator==@{operator==}!Xapian::PositionIterator@{Xapian::Position\-Iterator}}
\subsubsection[operator==]{\setlength{\rightskip}{0pt plus 5cm}bool operator== (const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \& {\em a}, const \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \& {\em b})\hspace{0.3cm}{\tt  \mbox{[}friend\mbox{]}}}}
\label{classXapian_1_1PositionIterator_834fe2a9af5f7e592e1ceaba44ceb1a3}


Test equality of two Position\-Iterators. 



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