<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::MSet Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1MSet.html">MSet</a></div>
<h1>Xapian::MSet Class Reference</h1><!-- doxytag: class="Xapian::MSet" -->A match set (<a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>).
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1MSet-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#94b032fd6e1f553c3ae55426e060ef9d">value_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#94b032fd6e1f553c3ae55426e060ef9d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#a3480fd5b79918d4852c4cbecf6dcc75">iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#a3480fd5b79918d4852c4cbecf6dcc75"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#51af38d2257520a7b1d2cf96c1dbfc72">const_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#51af38d2257520a7b1d2cf96c1dbfc72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#d3f3a0f565f46a4017355d7cb90aed33">reference</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#d3f3a0f565f46a4017355d7cb90aed33"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#6051e7b8c5af3dc639ec86966da2cd1f">const_reference</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#6051e7b8c5af3dc639ec86966da2cd1f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#78651fd2ddcce1e9c599d19ae56e4c22">pointer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#78651fd2ddcce1e9c599d19ae56e4c22"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#c0b722c47eee1eeef923379778e3ae5e">Xapian::doccount_diff</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#a851205f39cdfb77b877d73fc7f73b07">difference_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#a851205f39cdfb77b877d73fc7f73b07"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#aabde4da5e1ac994a05ebe514cab48fc">size_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <a href="#aabde4da5e1ac994a05ebe514cab48fc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca501ced91576fd98afa6f92a1cee88d"></a><!-- doxytag: member="Xapian::MSet::MSet" ref="ca501ced91576fd98afa6f92a1cee88d" args="(MSet::Internal *internal_)" -->
</td><td class="memItemRight" valign="bottom"><b>MSet</b> (MSet::Internal *internal_)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#7d80d85742bb6537f57df6e0e76f7ed8">MSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a>. <a href="#7d80d85742bb6537f57df6e0e76f7ed8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#ed6e1eb7e450a8be62fbd5e71f87cd5f">~MSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a>. <a href="#ed6e1eb7e450a8be62fbd5e71f87cd5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#29db53a0be0675e14569af8e7be4d818">MSet</a> (const <a class="el" href="classXapian_1_1MSet.html">MSet</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed (and is cheap). <a href="#29db53a0be0675e14569af8e7be4d818"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#89c5a5de5146152095e0866e8fefe606">operator=</a> (const <a class="el" href="classXapian_1_1MSet.html">MSet</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed (and is cheap). <a href="#89c5a5de5146152095e0866e8fefe606"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#db2219d7de85595b065aed56293c20a7">fetch</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &begin, const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &end) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the document info for a set of items in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#db2219d7de85595b065aed56293c20a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#c89dd5dc0bb3789f1cdb8e653cf62d71">fetch</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &item) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the single item specified. <a href="#c89dd5dc0bb3789f1cdb8e653cf62d71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#bd840e0924eebf055459d9cfe6b5b98f">fetch</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch all the items in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#bd840e0924eebf055459d9cfe6b5b98f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#86533cd9df01e80d23d758d74c7e1150">Xapian::percent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#c532ccd06b38eac5d8271ba0e15db7bf">convert_to_percent</a> (<a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> wt) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This converts the weight supplied to a percentage score. <a href="#c532ccd06b38eac5d8271ba0e15db7bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#86533cd9df01e80d23d758d74c7e1150">Xapian::percent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#e5f267d24f954c41e35a068b961ec308">convert_to_percent</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &it) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the percentage score for a particular item. <a href="#e5f267d24f954c41e35a068b961ec308"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#bf506c2762f7862252c38313966b258d">get_termfreq</a> (const std::string &tname) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the term frequency of the given query term. <a href="#bf506c2762f7862252c38313966b258d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#148b3469479b51499da05fa8fd4018bb">get_termweight</a> (const std::string &tname) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the term weight of the given query term. <a href="#148b3469479b51499da05fa8fd4018bb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#2fd4daefe4451f2840485818cb1215bf">get_firstitem</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The index of the first item in the result which was put into the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#2fd4daefe4451f2840485818cb1215bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#c0a357dc6d1edb65e2674b55af21775e">get_matches_lower_bound</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the number of documents in the database which match the query. <a href="#c0a357dc6d1edb65e2674b55af21775e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#9cfe70cb1ebf1b03811d4a506ded39d1">get_matches_estimated</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An estimate for the number of documents in the database which match the query. <a href="#9cfe70cb1ebf1b03811d4a506ded39d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#6a49d666d81ad994b513d9fbd510be06">get_matches_upper_bound</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the number of documents in the database which match the query. <a href="#6a49d666d81ad994b513d9fbd510be06"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#93c44548518177eb7d978c1cf7ec2794">get_max_possible</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum possible weight in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#93c44548518177eb7d978c1cf7ec2794"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#b0c18bec648ae0e179bef6f2461635fd">get_max_attained</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The greatest weight which is attained by any document in the database. <a href="#b0c18bec648ae0e179bef6f2461635fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#48598e8f6b699cad908b6759c187ef14">size</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of items in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#48598e8f6b699cad908b6759c187ef14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#223db21961c43d1d197a2bd8676bdf9f">max_size</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required to allow use as an STL container. <a href="#223db21961c43d1d197a2bd8676bdf9f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#471eb1519be560e90f8183923a4e9331">empty</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> is empty. <a href="#471eb1519be560e90f8183923a4e9331"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#8e0ad638d2525361bbbd804cc338f9c8">swap</a> (<a class="el" href="classXapian_1_1MSet.html">MSet</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Swap the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> we point to with another. <a href="#8e0ad638d2525361bbbd804cc338f9c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#78774b542a73ae93efbdac40461832e0">begin</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator for the terms in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#78774b542a73ae93efbdac40461832e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#421789abb6dfe45ee780b458c2452e51">end</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End iterator corresponding to <a class="el" href="classXapian_1_1MSet.html#78774b542a73ae93efbdac40461832e0" title="Iterator for the terms in this MSet.">begin()</a>. <a href="#421789abb6dfe45ee780b458c2452e51"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#a240f7e4db0423647a461214345fb40b">back</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator pointing to the last element of this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#a240f7e4db0423647a461214345fb40b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#60f6e570ebb5c6afc07d4bec14b3686d">operator[]</a> (<a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> i) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns the document at position i in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> object. <a href="#60f6e570ebb5c6afc07d4bec14b3686d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#74ac1fc4ebeb2ee2d61891d56a856983">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#74ac1fc4ebeb2ee2d61891d56a856983"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c0e517292df6f4818688e50bf68d1c8"></a><!-- doxytag: member="Xapian::MSet::internal" ref="1c0e517292df6f4818688e50bf68d1c8" args="" -->
Xapian::Internal::RefCntPtr<<br>
Internal > </td><td class="memItemRight" valign="bottom"><b>internal</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A match set (<a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>).
<p>
This class represents (a portion of) the results of a query.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="94b032fd6e1f553c3ae55426e060ef9d"></a><!-- doxytag: member="Xapian::MSet::value_type" ref="94b032fd6e1f553c3ae55426e060ef9d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSet::value_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="a3480fd5b79918d4852c4cbecf6dcc75"></a><!-- doxytag: member="Xapian::MSet::iterator" ref="a3480fd5b79918d4852c4cbecf6dcc75" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSet::iterator</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="51af38d2257520a7b1d2cf96c1dbfc72"></a><!-- doxytag: member="Xapian::MSet::const_iterator" ref="51af38d2257520a7b1d2cf96c1dbfc72" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSet::const_iterator</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="d3f3a0f565f46a4017355d7cb90aed33"></a><!-- doxytag: member="Xapian::MSet::reference" ref="d3f3a0f565f46a4017355d7cb90aed33" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a>& <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSet::reference</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="6051e7b8c5af3dc639ec86966da2cd1f"></a><!-- doxytag: member="Xapian::MSet::const_reference" ref="6051e7b8c5af3dc639ec86966da2cd1f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a>& <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSet::const_reference</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="78651fd2ddcce1e9c599d19ae56e4c22"></a><!-- doxytag: member="Xapian::MSet::pointer" ref="78651fd2ddcce1e9c599d19ae56e4c22" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a>* <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSet::pointer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="a851205f39cdfb77b877d73fc7f73b07"></a><!-- doxytag: member="Xapian::MSet::difference_type" ref="a851205f39cdfb77b877d73fc7f73b07" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="namespaceXapian.html#c0b722c47eee1eeef923379778e3ae5e">Xapian::doccount_diff</a> <a class="el" href="classXapian_1_1MSet.html#a851205f39cdfb77b877d73fc7f73b07">Xapian::MSet::difference_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="aabde4da5e1ac994a05ebe514cab48fc"></a><!-- doxytag: member="Xapian::MSet::size_type" ref="aabde4da5e1ac994a05ebe514cab48fc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> <a class="el" href="classXapian_1_1MSet.html#aabde4da5e1ac994a05ebe514cab48fc">Xapian::MSet::size_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL container.
<p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7d80d85742bb6537f57df6e0e76f7ed8"></a><!-- doxytag: member="Xapian::MSet::MSet" ref="7d80d85742bb6537f57df6e0e76f7ed8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::MSet::MSet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an empty <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="ed6e1eb7e450a8be62fbd5e71f87cd5f"></a><!-- doxytag: member="Xapian::MSet::~MSet" ref="ed6e1eb7e450a8be62fbd5e71f87cd5f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::MSet::~MSet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy a <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="29db53a0be0675e14569af8e7be4d818"></a><!-- doxytag: member="Xapian::MSet::MSet" ref="29db53a0be0675e14569af8e7be4d818" args="(const MSet &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::MSet::MSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSet.html">MSet</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copying is allowed (and is cheap).
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="89c5a5de5146152095e0866e8fefe606"></a><!-- doxytag: member="Xapian::MSet::operator=" ref="89c5a5de5146152095e0866e8fefe606" args="(const MSet &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::MSet::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSet.html">MSet</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment is allowed (and is cheap).
<p>
</div>
</div><p>
<a class="anchor" name="db2219d7de85595b065aed56293c20a7"></a><!-- doxytag: member="Xapian::MSet::fetch" ref="db2219d7de85595b065aed56293c20a7" args="(const MSetIterator &begin, const MSetIterator &end) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::MSet::fetch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"> <em>end</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fetch the document info for a set of items in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
This method causes the documents in the range specified by the iterators to be fetched from the database, and cached in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a> object. This has little effect when performing a search across a local database, but will greatly speed up subsequent access to the document contents when the documents are stored in a remote database.<p>
The iterators must be over this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a> - undefined behaviour will result otherwise.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td><a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> for first item to fetch. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td><a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> for item after last item to fetch. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c89dd5dc0bb3789f1cdb8e653cf62d71"></a><!-- doxytag: member="Xapian::MSet::fetch" ref="c89dd5dc0bb3789f1cdb8e653cf62d71" args="(const MSetIterator &item) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::MSet::fetch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"> <em>item</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fetch the single item specified.
<p>
</div>
</div><p>
<a class="anchor" name="bd840e0924eebf055459d9cfe6b5b98f"></a><!-- doxytag: member="Xapian::MSet::fetch" ref="bd840e0924eebf055459d9cfe6b5b98f" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::MSet::fetch </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fetch all the items in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="c532ccd06b38eac5d8271ba0e15db7bf"></a><!-- doxytag: member="Xapian::MSet::convert_to_percent" ref="c532ccd06b38eac5d8271ba0e15db7bf" args="(Xapian::weight wt) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#86533cd9df01e80d23d758d74c7e1150">Xapian::percent</a> Xapian::MSet::convert_to_percent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> </td>
<td class="paramname"> <em>wt</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This converts the weight supplied to a percentage score.
<p>
The return value will be in the range 0 to 100, and will be 0 if and only if the item did not match the query at all.
</div>
</div><p>
<a class="anchor" name="e5f267d24f954c41e35a068b961ec308"></a><!-- doxytag: member="Xapian::MSet::convert_to_percent" ref="e5f267d24f954c41e35a068b961ec308" args="(const MSetIterator &it) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#86533cd9df01e80d23d758d74c7e1150">Xapian::percent</a> Xapian::MSet::convert_to_percent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"> <em>it</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the percentage score for a particular item.
<p>
</div>
</div><p>
<a class="anchor" name="bf506c2762f7862252c38313966b258d"></a><!-- doxytag: member="Xapian::MSet::get_termfreq" ref="bf506c2762f7862252c38313966b258d" args="(const std::string &tname) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::MSet::get_termfreq </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>tname</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the term frequency of the given query term.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tname</em> </td><td>The term to look for.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></em> </td><td>is thrown if the term was not in the query. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="148b3469479b51499da05fa8fd4018bb"></a><!-- doxytag: member="Xapian::MSet::get_termweight" ref="148b3469479b51499da05fa8fd4018bb" args="(const std::string &tname) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::MSet::get_termweight </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>tname</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the term weight of the given query term.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tname</em> </td><td>The term to look for.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></em> </td><td>is thrown if the term was not in the query. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2fd4daefe4451f2840485818cb1215bf"></a><!-- doxytag: member="Xapian::MSet::get_firstitem" ref="2fd4daefe4451f2840485818cb1215bf" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::MSet::get_firstitem </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The index of the first item in the result which was put into the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
This corresponds to the parameter "first" specified in <a class="el" href="classXapian_1_1Enquire.html#b87e1a1d4302cf636edd04b848eabcbc" title="Get (a portion of) the match set for the current query.">Xapian::Enquire::get_mset()</a>. A value of 0 corresponds to the highest result being the first item in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
</div>
</div><p>
<a class="anchor" name="c0a357dc6d1edb65e2674b55af21775e"></a><!-- doxytag: member="Xapian::MSet::get_matches_lower_bound" ref="c0a357dc6d1edb65e2674b55af21775e" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::MSet::get_matches_lower_bound </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A lower bound on the number of documents in the database which match the query.
<p>
This figure takes into account collapsing of duplicates, and weighting cutoff values.<p>
This number is usually considerably less than the actual number of documents which match the query.
</div>
</div><p>
<a class="anchor" name="9cfe70cb1ebf1b03811d4a506ded39d1"></a><!-- doxytag: member="Xapian::MSet::get_matches_estimated" ref="9cfe70cb1ebf1b03811d4a506ded39d1" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::MSet::get_matches_estimated </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An estimate for the number of documents in the database which match the query.
<p>
This figure takes into account collapsing of duplicates, and weighting cutoff values.<p>
This value is returned because there is sometimes a request to display such information. However, our experience is that presenting this value to users causes them to worry about the large number of results, rather than how useful those at the top of the result set are, and is thus undesirable.
</div>
</div><p>
<a class="anchor" name="6a49d666d81ad994b513d9fbd510be06"></a><!-- doxytag: member="Xapian::MSet::get_matches_upper_bound" ref="6a49d666d81ad994b513d9fbd510be06" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::MSet::get_matches_upper_bound </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An upper bound on the number of documents in the database which match the query.
<p>
This figure takes into account collapsing of duplicates, and weighting cutoff values.<p>
This number is usually considerably greater than the actual number of documents which match the query.
</div>
</div><p>
<a class="anchor" name="93c44548518177eb7d978c1cf7ec2794"></a><!-- doxytag: member="Xapian::MSet::get_max_possible" ref="93c44548518177eb7d978c1cf7ec2794" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::MSet::get_max_possible </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The maximum possible weight in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
This weight is likely not to be attained in the set of results, but represents an upper bound on the weight which a document could attain for the given query.
</div>
</div><p>
<a class="anchor" name="b0c18bec648ae0e179bef6f2461635fd"></a><!-- doxytag: member="Xapian::MSet::get_max_attained" ref="b0c18bec648ae0e179bef6f2461635fd" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::MSet::get_max_attained </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The greatest weight which is attained by any document in the database.
<p>
If firstitem == 0 and the primary ordering is by relevance, this is the weight of the first entry in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.<p>
If no documents are found by the query, this will be 0.<p>
Note that calculation of max_attained requires calculation of at least one result item - therefore, if no items were requested when the query was performed (by specifying maxitems = 0 in <a class="el" href="classXapian_1_1Enquire.html#b87e1a1d4302cf636edd04b848eabcbc" title="Get (a portion of) the match set for the current query.">Xapian::Enquire::get_mset()</a>), this value will be 0.
</div>
</div><p>
<a class="anchor" name="48598e8f6b699cad908b6759c187ef14"></a><!-- doxytag: member="Xapian::MSet::size" ref="48598e8f6b699cad908b6759c187ef14" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::MSet::size </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number of items in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="223db21961c43d1d197a2bd8676bdf9f"></a><!-- doxytag: member="Xapian::MSet::max_size" ref="223db21961c43d1d197a2bd8676bdf9f" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> Xapian::MSet::max_size </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Required to allow use as an STL container.
<p>
</div>
</div><p>
<a class="anchor" name="471eb1519be560e90f8183923a4e9331"></a><!-- doxytag: member="Xapian::MSet::empty" ref="471eb1519be560e90f8183923a4e9331" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::MSet::empty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> is empty.
<p>
</div>
</div><p>
<a class="anchor" name="8e0ad638d2525361bbbd804cc338f9c8"></a><!-- doxytag: member="Xapian::MSet::swap" ref="8e0ad638d2525361bbbd804cc338f9c8" args="(MSet &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::MSet::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1MSet.html">MSet</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Swap the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> we point to with another.
<p>
</div>
</div><p>
<a class="anchor" name="78774b542a73ae93efbdac40461832e0"></a><!-- doxytag: member="Xapian::MSet::begin" ref="78774b542a73ae93efbdac40461832e0" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> Xapian::MSet::begin </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Iterator for the terms in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="421789abb6dfe45ee780b458c2452e51"></a><!-- doxytag: member="Xapian::MSet::end" ref="421789abb6dfe45ee780b458c2452e51" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> Xapian::MSet::end </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
End iterator corresponding to <a class="el" href="classXapian_1_1MSet.html#78774b542a73ae93efbdac40461832e0" title="Iterator for the terms in this MSet.">begin()</a>.
<p>
</div>
</div><p>
<a class="anchor" name="a240f7e4db0423647a461214345fb40b"></a><!-- doxytag: member="Xapian::MSet::back" ref="a240f7e4db0423647a461214345fb40b" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> Xapian::MSet::back </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Iterator pointing to the last element of this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="60f6e570ebb5c6afc07d4bec14b3686d"></a><!-- doxytag: member="Xapian::MSet::operator[]" ref="60f6e570ebb5c6afc07d4bec14b3686d" args="(Xapian::doccount i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> Xapian::MSet::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#44d2c93635cd10ee7d06a8d776f032cf">Xapian::doccount</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This returns the document at position i in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> object.
<p>
Note that this is not the same as the document at rank i in the query, unless the "first" parameter to <a class="el" href="classXapian_1_1Enquire.html#b87e1a1d4302cf636edd04b848eabcbc" title="Get (a portion of) the match set for the current query.">Xapian::Enquire::get_mset</a> was 0. Rather, it is the document at rank i + first.<p>
In other words, the offset is into the documents represented by this object, not into the set of documents matching the query.
</div>
</div><p>
<a class="anchor" name="74ac1fc4ebeb2ee2d61891d56a856983"></a><!-- doxytag: member="Xapian::MSet::get_description" ref="74ac1fc4ebeb2ee2d61891d56a856983" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::MSet::get_description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string describing this object.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="enquire_8h.html">enquire.h</a></ul>
<hr>
<address><small>
Documentation for Xapian (version 1.0.21).<br>
Generated on 18 Jun 2010 by
<a href="http://www.doxygen.org/">Doxygen 1.5.2</a>.
</small></address>
</body>
</html>
