classxapian_1_1postingiterator.tex

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

\hypertarget{classXapian_1_1PostingIterator}{
\section{Xapian::Posting\-Iterator Class Reference}
\label{classXapian_1_1PostingIterator}\index{Xapian::PostingIterator@{Xapian::PostingIterator}}
}
An iterator pointing to items in a list of postings.  


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

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

\item 
\hypertarget{classXapian_1_1PostingIterator_a95ef4f8e09c54c347f863cd2814de11}{
typedef \hyperlink{types_8h_d8243c2a1cbe7e9f88ab4704233f531e}{Xapian::doccount\_\-diff} {\bf difference\_\-type}}
\label{classXapian_1_1PostingIterator_a95ef4f8e09c54c347f863cd2814de11}

\item 
\hypertarget{classXapian_1_1PostingIterator_c8aba644bb6ace6a773eff34a1587853}{
typedef \hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{Xapian::docid} $\ast$ {\bf pointer}}
\label{classXapian_1_1PostingIterator_c8aba644bb6ace6a773eff34a1587853}

\item 
\hypertarget{classXapian_1_1PostingIterator_eaa71e8d29d4cbe492be8a8e5cff512c}{
typedef \hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{Xapian::docid} \& {\bf reference}}
\label{classXapian_1_1PostingIterator_eaa71e8d29d4cbe492be8a8e5cff512c}

\end{CompactItemize}
\end{Indent}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{classXapian_1_1PostingIterator_e75789243bba29a7911173979aadca43}{Posting\-Iterator} ()
\begin{CompactList}\small\item\em Default constructor - for declaring an uninitialised iterator. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PostingIterator_688eb4778f5dafb7d1a589010216dbe4}{$\sim$Posting\-Iterator} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PostingIterator_d4a09de16483b0e9aeb49adc7fefb707}{Posting\-Iterator} (const \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \&other)
\begin{CompactList}\small\item\em Copying is allowed. \item\end{CompactList}\item 
void \hyperlink{classXapian_1_1PostingIterator_c74abb0678bf756aae322b83805deef5}{operator=} (const \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \&other)
\begin{CompactList}\small\item\em Assignment is allowed. \item\end{CompactList}\item 
\hypertarget{classXapian_1_1PostingIterator_12252ab2accdd682265c58eef1871d13}{
\hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \& {\bf operator++} ()}
\label{classXapian_1_1PostingIterator_12252ab2accdd682265c58eef1871d13}

\item 
\hypertarget{classXapian_1_1PostingIterator_336f3df8154faaa7c00aad5fdb43d59c}{
\hyperlink{classXapian_1_1DocIDWrapper}{Doc\-IDWrapper} {\bf operator++} (int)}
\label{classXapian_1_1PostingIterator_336f3df8154faaa7c00aad5fdb43d59c}

\item 
void \hyperlink{classXapian_1_1PostingIterator_665a45d91c6c7ea010b4c9f3b2efbe9e}{skip\_\-to} (\hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{Xapian::docid} did)
\begin{CompactList}\small\item\em Skip the iterator to document did, or the first document after did if did isn't in the list of documents being iterated. \item\end{CompactList}\item 
\hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{Xapian::docid} \hyperlink{classXapian_1_1PostingIterator_094496f351cc84f1663329000c3b0a4c}{operator $\ast$} () const 
\begin{CompactList}\small\item\em Get the document id at the current position in the postlist. \item\end{CompactList}\item 
\hyperlink{types_8h_7272583216038f810105df7dc927723c}{Xapian::doclength} \hyperlink{classXapian_1_1PostingIterator_af3b068417bb2e3d80bfcb1c15260e4a}{get\_\-doclength} () const 
\begin{CompactList}\small\item\em Get the length of the document at the current position in the postlist. \item\end{CompactList}\item 
\hyperlink{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}{Xapian::termcount} \hyperlink{classXapian_1_1PostingIterator_c05e628e438614e20a4b1292cb982b87}{get\_\-wdf} () const 
\begin{CompactList}\small\item\em Get the within document frequency of the document at the current position in the postlist. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \hyperlink{classXapian_1_1PostingIterator_94935d23e4806725737426ee298322c3}{positionlist\_\-begin} () const 
\begin{CompactList}\small\item\em Return \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} pointing to start of positionlist for current document. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} \hyperlink{classXapian_1_1PostingIterator_618c4e850550b870cbddc640e0f8a489}{positionlist\_\-end} () const 
\begin{CompactList}\small\item\em Return \hyperlink{classXapian_1_1PositionIterator}{Position\-Iterator} pointing to end of positionlist for current document. \item\end{CompactList}\item 
std::string \hyperlink{classXapian_1_1PostingIterator_8e4a19ca6b9fb16ad3e266ed7a676e3a}{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_1PostingIterator_bc9f66845889d6a5a12c8fb6095e7baf}{
\hyperlink{classXapian_1_1Internal_1_1RefCntPtr}{Xapian::Internal::Ref\-Cnt\-Ptr}$<$ Internal $>$ {\bf internal}}
\label{classXapian_1_1PostingIterator_bc9f66845889d6a5a12c8fb6095e7baf}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1PostingIterator_6efef52d7a939622bbc934ff6b90ffe0}{
class {\bf Database}}
\label{classXapian_1_1PostingIterator_6efef52d7a939622bbc934ff6b90ffe0}

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


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



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


Allow use as an STL iterator. 



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


Default constructor - for declaring an uninitialised iterator. 

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


Destructor. 

\hypertarget{classXapian_1_1PostingIterator_d4a09de16483b0e9aeb49adc7fefb707}{
\index{Xapian::PostingIterator@{Xapian::Posting\-Iterator}!PostingIterator@{PostingIterator}}
\index{PostingIterator@{PostingIterator}!Xapian::PostingIterator@{Xapian::Posting\-Iterator}}
\subsubsection[PostingIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Posting\-Iterator::Posting\-Iterator (const \hyperlink{classXapian_1_1PostingIterator}{Posting\-Iterator} \& {\em other})}}
\label{classXapian_1_1PostingIterator_d4a09de16483b0e9aeb49adc7fefb707}


Copying is allowed. 

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

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


Returns a string describing this object. 

Introspection method. \hypertarget{classXapian_1_1PostingIterator_af3b068417bb2e3d80bfcb1c15260e4a}{
\index{Xapian::PostingIterator@{Xapian::Posting\-Iterator}!get_doclength@{get\_\-doclength}}
\index{get_doclength@{get\_\-doclength}!Xapian::PostingIterator@{Xapian::Posting\-Iterator}}
\subsubsection[get\_\-doclength]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_7272583216038f810105df7dc927723c}{Xapian::doclength} Xapian::Posting\-Iterator::get\_\-doclength () const}}
\label{classXapian_1_1PostingIterator_af3b068417bb2e3d80bfcb1c15260e4a}


Get the length of the document at the current position in the postlist. 

This information may be stored in the postlist, in which case this lookup should be extremely fast (indeed, not require further disk access). If the information is not present in the postlist, it will be retrieved from the database, at a greater performance cost. \hypertarget{classXapian_1_1PostingIterator_c05e628e438614e20a4b1292cb982b87}{
\index{Xapian::PostingIterator@{Xapian::Posting\-Iterator}!get_wdf@{get\_\-wdf}}
\index{get_wdf@{get\_\-wdf}!Xapian::PostingIterator@{Xapian::Posting\-Iterator}}
\subsubsection[get\_\-wdf]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_6979d98ebbe67186bd31e5ee2a7585cb}{Xapian::termcount} Xapian::Posting\-Iterator::get\_\-wdf () const}}
\label{classXapian_1_1PostingIterator_c05e628e438614e20a4b1292cb982b87}


Get the within document frequency of the document at the current position in the postlist. 

\hypertarget{classXapian_1_1PostingIterator_094496f351cc84f1663329000c3b0a4c}{
\index{Xapian::PostingIterator@{Xapian::Posting\-Iterator}!operator *@{operator $\ast$}}
\index{operator *@{operator $\ast$}!Xapian::PostingIterator@{Xapian::Posting\-Iterator}}
\subsubsection[operator $\ast$]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{Xapian::docid} Xapian::Posting\-Iterator::operator $\ast$ () const}}
\label{classXapian_1_1PostingIterator_094496f351cc84f1663329000c3b0a4c}


Get the document id at the current position in the postlist. 

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


Assignment is allowed. 

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


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

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


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

\hypertarget{classXapian_1_1PostingIterator_665a45d91c6c7ea010b4c9f3b2efbe9e}{
\index{Xapian::PostingIterator@{Xapian::Posting\-Iterator}!skip_to@{skip\_\-to}}
\index{skip_to@{skip\_\-to}!Xapian::PostingIterator@{Xapian::Posting\-Iterator}}
\subsubsection[skip\_\-to]{\setlength{\rightskip}{0pt plus 5cm}void Xapian::Posting\-Iterator::skip\_\-to (\hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{Xapian::docid} {\em did})}}
\label{classXapian_1_1PostingIterator_665a45d91c6c7ea010b4c9f3b2efbe9e}


Skip the iterator to document did, or the first document after did if did isn't in the list of documents being iterated. 



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


Test equality of two Posting\-Iterators. 



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