<!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.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1RSet.html">RSet</a>
</div>
</div>
<div class="contents">
<h1>Xapian::RSet Class Reference</h1><!-- doxytag: class="Xapian::RSet" -->A relevance set (R-Set).
<a href="#_details">More...</a>
<p>
<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"><a class="anchor" name="50ed96a2396032db1297bdb3bef3fbc5"></a><!-- doxytag: member="Xapian::RSet::RSet" ref="50ed96a2396032db1297bdb3bef3fbc5" args="(const RSet &rset)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#50ed96a2396032db1297bdb3bef3fbc5">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="105bf6917dffc68fb551e775fd67202a"></a><!-- doxytag: member="Xapian::RSet::operator=" ref="105bf6917dffc68fb551e775fd67202a" args="(const RSet &rset)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#105bf6917dffc68fb551e775fd67202a">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="142298edba05bbdc1d1dd11fdbc88020"></a><!-- doxytag: member="Xapian::RSet::RSet" ref="142298edba05bbdc1d1dd11fdbc88020" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#142298edba05bbdc1d1dd11fdbc88020">RSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571c4c3bbeeca8e051f36037c62b70f"></a><!-- doxytag: member="Xapian::RSet::~RSet" ref="5571c4c3bbeeca8e051f36037c62b70f" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#5571c4c3bbeeca8e051f36037c62b70f">~RSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3db90f712138087c56a026c51a3c5124"></a><!-- doxytag: member="Xapian::RSet::size" ref="3db90f712138087c56a026c51a3c5124" args="() const " -->
<a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#3db90f712138087c56a026c51a3c5124">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of documents in this R-Set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55cb1a5a9d7410e4dcc2a786934df505"></a><!-- doxytag: member="Xapian::RSet::empty" ref="55cb1a5a9d7410e4dcc2a786934df505" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#55cb1a5a9d7410e4dcc2a786934df505">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this R-Set is empty. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4eec40ff21b85b939ebab9a710df747f"></a><!-- doxytag: member="Xapian::RSet::add_document" ref="4eec40ff21b85b939ebab9a710df747f" args="(Xapian::docid did)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#4eec40ff21b85b939ebab9a710df747f">add_document</a> (<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> did)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a document to the relevance set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adc23b11f6ca60415a3fa595325af5eb"></a><!-- doxytag: member="Xapian::RSet::add_document" ref="adc23b11f6ca60415a3fa595325af5eb" args="(const Xapian::MSetIterator &i)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#adc23b11f6ca60415a3fa595325af5eb">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58ae59e71967d119296231c6ac905dbb"></a><!-- doxytag: member="Xapian::RSet::remove_document" ref="58ae59e71967d119296231c6ac905dbb" args="(Xapian::docid did)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#58ae59e71967d119296231c6ac905dbb">remove_document</a> (<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> did)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a document from the relevance set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="459ec695ed5ab2e10b56aa56c2e453be"></a><!-- doxytag: member="Xapian::RSet::remove_document" ref="459ec695ed5ab2e10b56aa56c2e453be" args="(const Xapian::MSetIterator &i)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#459ec695ed5ab2e10b56aa56c2e453be">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="24efe6d2b88a8f799be5078994e49098"></a><!-- doxytag: member="Xapian::RSet::contains" ref="24efe6d2b88a8f799be5078994e49098" args="(Xapian::docid did) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#24efe6d2b88a8f799be5078994e49098">contains</a> (<a class="el" href="namespaceXapian.html#8fa9094bebe1256a7be935a5ede87a64">Xapian::docid</a> did) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if a given document in the relevance set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d05be25606bc278d55ecefa5c7e7254c"></a><!-- doxytag: member="Xapian::RSet::contains" ref="d05be25606bc278d55ecefa5c7e7254c" args="(const Xapian::MSetIterator &i) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#d05be25606bc278d55ecefa5c7e7254c">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="636afe3253b0f8922dffc3a47808b1a1"></a><!-- doxytag: member="Xapian::RSet::get_description" ref="636afe3253b0f8922dffc3a47808b1a1" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1RSet.html#636afe3253b0f8922dffc3a47808b1a1">get_description</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br></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. <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>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>
