classxapian_1_1msetiterator.tex

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

\subsection{Member Function Documentation}
\hypertarget{classXapian_1_1MSetIterator_4d2d8fae854bc997dd417234061a3fe2}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!get_collapse_count@{get\_\-collapse\_\-count}}
\index{get_collapse_count@{get\_\-collapse\_\-count}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[get\_\-collapse\_\-count]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{Xapian::doccount} Xapian::MSet\-Iterator::get\_\-collapse\_\-count () const}}
\label{classXapian_1_1MSetIterator_4d2d8fae854bc997dd417234061a3fe2}


Get an estimate of the number of documents that have been collapsed into this one. 

The estimate will always be less than or equal to the actual number of other documents satisfying the match criteria with the same collapse key as this document.

This method may return 0 even though there are other documents with the same collapse key which satisfying the match criteria. However if this method returns non-zero, there definitely are other such documents. So this method may be used to inform the user that there are \char`\"{}at least N other matches in this group\char`\"{}, or to control whether to offer a \char`\"{}show other documents in this group\char`\"{} feature (but note that it may not offer it in every case where it would show other documents). \hypertarget{classXapian_1_1MSetIterator_95d1c5a337e5f128e58bf68745b036c2}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!get_description@{get\_\-description}}
\index{get_description@{get\_\-description}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[get\_\-description]{\setlength{\rightskip}{0pt plus 5cm}std::string Xapian::MSet\-Iterator::get\_\-description () const}}
\label{classXapian_1_1MSetIterator_95d1c5a337e5f128e58bf68745b036c2}


Returns a string describing this object. 

Introspection method. \hypertarget{classXapian_1_1MSetIterator_b3cd71bd6aa3b5677eacf99f369e482c}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!get_document@{get\_\-document}}
\index{get_document@{get\_\-document}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[get\_\-document]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classXapian_1_1Document}{Xapian::Document} Xapian::MSet\-Iterator::get\_\-document () const}}
\label{classXapian_1_1MSetIterator_b3cd71bd6aa3b5677eacf99f369e482c}


Get a \hyperlink{classXapian_1_1Document}{Xapian::Document} object for the current position. 

This method returns a \hyperlink{classXapian_1_1Document}{Xapian::Document} object which provides the information about the document pointed to by the \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator}.

If the underlying database has suitable support, using this call (rather than asking the database for a document based on its document ID) will enable the system to ensure that the correct data is returned, and that the document has not been deleted or changed since the query was performed.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em it}]The \hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} for which to retrieve the data.\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A \hyperlink{classXapian_1_1Document}{Xapian::Document} object containing the document data.\end{Desc}
\begin{Desc}
\item[Exceptions:]
\begin{description}
\item[{\em Xapian::Doc\-Not\-Found\-Error}]The document specified could not be found in the database. \end{description}
\end{Desc}
\hypertarget{classXapian_1_1MSetIterator_99514c11a9291175d20fafa73a0839fd}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!get_percent@{get\_\-percent}}
\index{get_percent@{get\_\-percent}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[get\_\-percent]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_d9213278aaed43f1ab0110c87a6b7476}{Xapian::percent} Xapian::MSet\-Iterator::get\_\-percent () const}}
\label{classXapian_1_1MSetIterator_99514c11a9291175d20fafa73a0839fd}


This returns the weight of the document as a percentage score. 

The return value will be in the range 0 to 100: 0 meaning that the item did not match the query at all. \hypertarget{classXapian_1_1MSetIterator_7921b513e0e0b055134c8c1c8264a149}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!get_rank@{get\_\-rank}}
\index{get_rank@{get\_\-rank}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[get\_\-rank]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_b4166dca4ac15d88c933bbb8e0d55d23}{Xapian::doccount} Xapian::MSet\-Iterator::get\_\-rank () const\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1MSetIterator_7921b513e0e0b055134c8c1c8264a149}


Get the rank of the document at the current position. 

The rank is the position that this document is at in the ordered list of results of the query. The document judged \char`\"{}most relevant\char`\"{} will have rank of 0. \hypertarget{classXapian_1_1MSetIterator_b0cdaf0f122fb363b2bbff50ec8d1a00}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!get_weight@{get\_\-weight}}
\index{get_weight@{get\_\-weight}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[get\_\-weight]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_167860ee249b702eb746dca0d245f808}{Xapian::weight} Xapian::MSet\-Iterator::get\_\-weight () const}}
\label{classXapian_1_1MSetIterator_b0cdaf0f122fb363b2bbff50ec8d1a00}


Get the weight of the document at the current position. 

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


Get the document ID for the current position. 

\hypertarget{classXapian_1_1MSetIterator_fa449795683d7ffe7387db58373d6fee}{
\index{Xapian::MSetIterator@{Xapian::MSet\-Iterator}!operator++@{operator++}}
\index{operator++@{operator++}!Xapian::MSetIterator@{Xapian::MSet\-Iterator}}
\subsubsection[operator++]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classXapian_1_1MSetIterator}{MSet\-Iterator} Xapian::MSet\-Iterator::operator++ (int)\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1MSetIterator_fa449795683d7ffe7387db58373d6fee}


Advance the iterator (postfix variant). 

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


Advance the iterator. 

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


Decrement the iterator (postfix variant). 

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


Decrement the iterator. 

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


Assignment is allowed (and is cheap). 



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