<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::RSet 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_1RSet.html">RSet</a></div>
<h1>Xapian::RSet Class Reference</h1><!-- doxytag: class="Xapian::RSet" -->A relevance set (R-Set).
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1RSet-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#a29e7e30901116015eeb21f7903cda76">RSet</a> (const <a class="el" href="classXapian_1_1RSet.html">RSet</a> &rset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a29e7e30901116015eeb21f7903cda76"></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_1RSet.html#6dfd39efeef7dadeb2b925c8c5b32560">operator=</a> (const <a class="el" href="classXapian_1_1RSet.html">RSet</a> &rset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#6dfd39efeef7dadeb2b925c8c5b32560"></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_1RSet.html#6bdb04a61eb1f973011cf3b4e6fbef3e">RSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#6bdb04a61eb1f973011cf3b4e6fbef3e"></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_1RSet.html#3d2ff933b6bed384b028642e371c1eca">~RSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#3d2ff933b6bed384b028642e371c1eca"></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_1RSet.html#7ac6b2a5ed401fc34ba466b83ccfaf44">size</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of documents in this R-Set. <a href="#7ac6b2a5ed401fc34ba466b83ccfaf44"></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_1RSet.html#85d57d98ce742df1a27e9cbacdfe5535">empty</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this R-Set is empty. <a href="#85d57d98ce742df1a27e9cbacdfe5535"></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_1RSet.html#21b90aa58e349bfc13c6568078a4f1fd">add_document</a> (<a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> did)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a document to the relevance set. <a href="#21b90aa58e349bfc13c6568078a4f1fd"></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_1RSet.html#a3e5e3449d12cf4a31a3d412bcfe7e0d">add_document</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> &i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a document to the relevance set. <a href="#a3e5e3449d12cf4a31a3d412bcfe7e0d"></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_1RSet.html#9fcd473a46a72e7da53d776a2ef64a9a">remove_document</a> (<a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> did)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a document from the relevance set. <a href="#9fcd473a46a72e7da53d776a2ef64a9a"></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_1RSet.html#681ee66eae3c60c6bcd467805f91fa8d">remove_document</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> &i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a document from the relevance set. <a href="#681ee66eae3c60c6bcd467805f91fa8d"></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_1RSet.html#98e27d37aa266416a93f9b5578b227b7">contains</a> (<a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> did) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a given document in the relevance set. <a href="#98e27d37aa266416a93f9b5578b227b7"></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_1RSet.html#2f8cf628f5dfb0753f88e5f620a3a7b4">contains</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> &i) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a given document in the relevance set. <a href="#2f8cf628f5dfb0753f88e5f620a3a7b4"></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_1RSet.html#12725813d7d4de06fef43e63d039ebf7">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#12725813d7d4de06fef43e63d039ebf7"></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="c35cd225912a9f2a69cc11e8e2ebe18a"></a><!-- doxytag: member="Xapian::RSet::internal" ref="c35cd225912a9f2a69cc11e8e2ebe18a" 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 relevance set (R-Set).
<p>
This is the set of documents which are marked as relevant, for use in modifying the term weights, and in performing query expansion.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a29e7e30901116015eeb21f7903cda76"></a><!-- doxytag: member="Xapian::RSet::RSet" ref="a29e7e30901116015eeb21f7903cda76" args="(const RSet &rset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::RSet::RSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1RSet.html">RSet</a> & </td>
<td class="paramname"> <em>rset</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
</div>
</div><p>
<a class="anchor" name="6bdb04a61eb1f973011cf3b4e6fbef3e"></a><!-- doxytag: member="Xapian::RSet::RSet" ref="6bdb04a61eb1f973011cf3b4e6fbef3e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::RSet::RSet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="3d2ff933b6bed384b028642e371c1eca"></a><!-- doxytag: member="Xapian::RSet::~RSet" ref="3d2ff933b6bed384b028642e371c1eca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::RSet::~RSet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6dfd39efeef7dadeb2b925c8c5b32560"></a><!-- doxytag: member="Xapian::RSet::operator=" ref="6dfd39efeef7dadeb2b925c8c5b32560" args="(const RSet &rset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::RSet::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1RSet.html">RSet</a> & </td>
<td class="paramname"> <em>rset</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator.
<p>
</div>
</div><p>
<a class="anchor" name="7ac6b2a5ed401fc34ba466b83ccfaf44"></a><!-- doxytag: member="Xapian::RSet::size" ref="7ac6b2a5ed401fc34ba466b83ccfaf44" 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::RSet::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 documents in this R-Set.
<p>
</div>
</div><p>
<a class="anchor" name="85d57d98ce742df1a27e9cbacdfe5535"></a><!-- doxytag: member="Xapian::RSet::empty" ref="85d57d98ce742df1a27e9cbacdfe5535" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::RSet::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 R-Set is empty.
<p>
</div>
</div><p>
<a class="anchor" name="21b90aa58e349bfc13c6568078a4f1fd"></a><!-- doxytag: member="Xapian::RSet::add_document" ref="21b90aa58e349bfc13c6568078a4f1fd" args="(Xapian::docid did)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::RSet::add_document </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> </td>
<td class="paramname"> <em>did</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a document to the relevance set.
<p>
</div>
</div><p>
<a class="anchor" name="a3e5e3449d12cf4a31a3d412bcfe7e0d"></a><!-- doxytag: member="Xapian::RSet::add_document" ref="a3e5e3449d12cf4a31a3d412bcfe7e0d" args="(const Xapian::MSetIterator &i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::RSet::add_document </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> & </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a document to the relevance set.
<p>
</div>
</div><p>
<a class="anchor" name="9fcd473a46a72e7da53d776a2ef64a9a"></a><!-- doxytag: member="Xapian::RSet::remove_document" ref="9fcd473a46a72e7da53d776a2ef64a9a" args="(Xapian::docid did)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::RSet::remove_document </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> </td>
<td class="paramname"> <em>did</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a document from the relevance set.
<p>
</div>
</div><p>
<a class="anchor" name="681ee66eae3c60c6bcd467805f91fa8d"></a><!-- doxytag: member="Xapian::RSet::remove_document" ref="681ee66eae3c60c6bcd467805f91fa8d" args="(const Xapian::MSetIterator &i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::RSet::remove_document </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> & </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a document from the relevance set.
<p>
</div>
</div><p>
<a class="anchor" name="98e27d37aa266416a93f9b5578b227b7"></a><!-- doxytag: member="Xapian::RSet::contains" ref="98e27d37aa266416a93f9b5578b227b7" args="(Xapian::docid did) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::RSet::contains </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#d8d873ad5830cff0b4bbd89d7da45d15">Xapian::docid</a> </td>
<td class="paramname"> <em>did</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if a given document in the relevance set.
<p>
</div>
</div><p>
<a class="anchor" name="2f8cf628f5dfb0753f88e5f620a3a7b4"></a><!-- doxytag: member="Xapian::RSet::contains" ref="2f8cf628f5dfb0753f88e5f620a3a7b4" args="(const Xapian::MSetIterator &i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::RSet::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">Xapian::MSetIterator</a> & </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if a given document in the relevance set.
<p>
</div>
</div><p>
<a class="anchor" name="12725813d7d4de06fef43e63d039ebf7"></a><!-- doxytag: member="Xapian::RSet::get_description" ref="12725813d7d4de06fef43e63d039ebf7" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::RSet::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>
