classxapian_1_1msetiterator.tex

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

\hypertarget{classXapian_1_1MSetIterator}{
\section{Xapian::MSet\-Iterator Class Reference}
\label{classXapian_1_1MSetIterator}\index{Xapian::MSetIterator@{Xapian::MSetIterator}}
}
An iterator pointing to items in an \hyperlink{classXapian_1_1MSet}{MSet}.  


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

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

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

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

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

\end{CompactItemize}
\end{Indent}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{classXapian_1_1MSetIterator_24089616ca88737d235d50fe39c10a5b}{MSet\-Iterator} ()
\begin{CompactList}\small\item\em Create an uninitialised iterator; this cannot be used, but is convenient syntactically. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1MSetIterator_65b8ccf4acd764feb8c29afc0f25e5ac}{MSet\-Iterator} (const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&other)
\begin{CompactList}\small\item\em Copying is allowed (and is cheap). \item\end{CompactList}\item 
void \hyperlink{classXapian_1_1MSetIterator_109ec6c9a89d390ac82479905ae2b5e1}{operator=} (const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&other)
\begin{CompactList}\small\item\em Assignment is allowed (and is cheap). \item\end{CompactList}\item 
\hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \& \hyperlink{classXapian_1_1MSetIterator_d4ac6e0c3cac3be285be16b1bf5bf490}{operator++} ()
\begin{CompactList}\small\item\em Advance the iterator. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \hyperlink{classXapian_1_1MSetIterator_fa449795683d7ffe7387db58373d6fee}{operator++} (int)
\begin{CompactList}\small\item\em Advance the iterator (postfix variant). \item\end{CompactList}\item 
\hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \& \hyperlink{classXapian_1_1MSetIterator_4b904a30ffcd05700a908ee7e9645a61}{operator--} ()
\begin{CompactList}\small\item\em Decrement the iterator. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \hyperlink{classXapian_1_1MSetIterator_dadef547ef6a82c35d6a78b2187a56c4}{operator--} (int)
\begin{CompactList}\small\item\em Decrement the iterator (postfix variant). \item\end{CompactList}\item 
\hyperlink{types_8h_53073891e45d892a8d8a5d8f87f41402}{Xapian::docid} \hyperlink{classXapian_1_1MSetIterator_34d6bbe04757a8d20c759fa322cdaf37}{operator $\ast$} () const 
\begin{CompactList}\small\item\em Get the document ID for the current position. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1Document}{Xapian::Document} \hyperlink{classXapian_1_1MSetIterator_b3cd71bd6aa3b5677eacf99f369e482c}{get\_\-document} () const 
\begin{CompactList}\small\item\em Get a \hyperlink{classXapian_1_1Document}{Xapian::Document} object for the current position. \item\end{CompactList}\item 
\hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{Xapian::doccount} \hyperlink{classXapian_1_1MSetIterator_7921b513e0e0b055134c8c1c8264a149}{get\_\-rank} () const 
\begin{CompactList}\small\item\em Get the rank of the document at the current position. \item\end{CompactList}\item 
\hyperlink{types_8h_167860ee249b702eb746dca0d245f808}{Xapian::weight} \hyperlink{classXapian_1_1MSetIterator_b0cdaf0f122fb363b2bbff50ec8d1a00}{get\_\-weight} () const 
\begin{CompactList}\small\item\em Get the weight of the document at the current position. \item\end{CompactList}\item 
\hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{Xapian::doccount} \hyperlink{classXapian_1_1MSetIterator_4d2d8fae854bc997dd417234061a3fe2}{get\_\-collapse\_\-count} () const 
\begin{CompactList}\small\item\em Get an estimate of the number of documents that have been collapsed into this one. \item\end{CompactList}\item 
\hyperlink{types_8h_d9213278aaed43f1ab0110c87a6b7476}{Xapian::percent} \hyperlink{classXapian_1_1MSetIterator_99514c11a9291175d20fafa73a0839fd}{get\_\-percent} () const 
\begin{CompactList}\small\item\em This returns the weight of the document as a percentage score. \item\end{CompactList}\item 
std::string \hyperlink{classXapian_1_1MSetIterator_95d1c5a337e5f128e58bf68745b036c2}{get\_\-description} () const 
\begin{CompactList}\small\item\em Returns a string describing this object. \item\end{CompactList}\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1MSetIterator_20e87aae0635cec1454b45a069151671}{
class {\bf MSet}}
\label{classXapian_1_1MSetIterator_20e87aae0635cec1454b45a069151671}

\item 
\hypertarget{classXapian_1_1MSetIterator_4107b130f6713cad73255369d6b43f91}{
bool {\bf operator==} (const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&a, const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&b)}
\label{classXapian_1_1MSetIterator_4107b130f6713cad73255369d6b43f91}

\item 
\hypertarget{classXapian_1_1MSetIterator_44de20741fa12cd650ee986e57a51161}{
bool {\bf operator!=} (const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&a, const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \&b)}
\label{classXapian_1_1MSetIterator_44de20741fa12cd650ee986e57a51161}

\end{CompactItemize}


\subsection{Detailed Description}
An iterator pointing to items in an \hyperlink{classXapian_1_1MSet}{MSet}. 

This is used for access to individual results of a match. 



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


Allow use as an STL iterator. 



\subsection{Constructor \& Destructor Documentation}
\hypertarget{classXapian_1_1MSetIterator_24089616ca88737d235d50fe39c10a5b}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!MSetIterator@{MSetIterator}}
\index{MSetIterator@{MSetIterator}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[MSetIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::MSet\-Iterator::MSet\-Iterator ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1MSetIterator_24089616ca88737d235d50fe39c10a5b}


Create an uninitialised iterator; this cannot be used, but is convenient syntactically. 

\hypertarget{classXapian_1_1MSetIterator_65b8ccf4acd764feb8c29afc0f25e5ac}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!MSetIterator@{MSetIterator}}
\index{MSetIterator@{MSetIterator}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[MSetIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::MSet\-Iterator::MSet\-Iterator (const \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} \& {\em other})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1MSetIterator_65b8ccf4acd764feb8c29afc0f25e5ac}


Copying is allowed (and is cheap).