<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::ESet 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_1ESet.html">ESet</a></div>
<h1>Xapian::ESet Class Reference</h1><!-- doxytag: class="Xapian::ESet" -->Class representing an ordered set of expand terms (an <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>).
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1ESet-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_1ESet.html#adacae781fdeba5646a1d70055985198">ESet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>. <a href="#adacae781fdeba5646a1d70055985198"></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_1ESet.html#8af38835f095c27a544555c6930bee3d">~ESet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#8af38835f095c27a544555c6930bee3d"></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_1ESet.html#576e843f259fb3a6e3f9b18f631daae7">ESet</a> (const <a class="el" href="classXapian_1_1ESet.html">ESet</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed (and is cheap). <a href="#576e843f259fb3a6e3f9b18f631daae7"></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_1ESet.html#c43556828adbf77c352355a9f7fae5ea">operator=</a> (const <a class="el" href="classXapian_1_1ESet.html">ESet</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed (and is cheap). <a href="#c43556828adbf77c352355a9f7fae5ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#8abc4cffbc1fc9100d1e861fbe1f4002">get_ebound</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the number of terms which are in the full set of results of the expand. <a href="#8abc4cffbc1fc9100d1e861fbe1f4002"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#d22011cccddf4aff3d2bfb292bed9d42">size</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of terms in this E-Set. <a href="#d22011cccddf4aff3d2bfb292bed9d42"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#cbb95341846eea1cae721e7b22e3a997">max_size</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required to allow use as an STL container. <a href="#cbb95341846eea1cae721e7b22e3a997"></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_1ESet.html#9de1a6cdbaac5594178c5b3dc3c4db75">empty</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this E-Set is empty. <a href="#9de1a6cdbaac5594178c5b3dc3c4db75"></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_1ESet.html#a70e35b66525da06573b1ac083ff1158">swap</a> (<a class="el" href="classXapian_1_1ESet.html">ESet</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Swap the E-Set we point to with another. <a href="#a70e35b66525da06573b1ac083ff1158"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#29ac1edf35733106b404b50568bcca85">begin</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator for the terms in this E-Set. <a href="#29ac1edf35733106b404b50568bcca85"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#6db64b05acc483ee1ec33cfae8b4e00d">end</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End iterator corresponding to <a class="el" href="classXapian_1_1ESet.html#29ac1edf35733106b404b50568bcca85" title="Iterator for the terms in this E-Set.">begin()</a>. <a href="#6db64b05acc483ee1ec33cfae8b4e00d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#7f897ada9435f3599ea6e502edaf637d">back</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator pointing to the last element of this E-Set. <a href="#7f897ada9435f3599ea6e502edaf637d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#b9c5955a45b03298da080c74ab735ced">operator[]</a> (<a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> i) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns the term at position i in this E-Set. <a href="#b9c5955a45b03298da080c74ab735ced"></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_1ESet.html#8a120eb731c621775dcc0803663205bf">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#8a120eb731c621775dcc0803663205bf"></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="c5ba968387dacbccf84a05a9af10a069"></a><!-- doxytag: member="Xapian::ESet::internal" ref="c5ba968387dacbccf84a05a9af10a069" 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>
Class representing an ordered set of expand terms (an <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>).
<p>
This set represents the results of an expand operation, which is performed by <a class="el" href="classXapian_1_1Enquire.html#274b654da131960486acdaa2f095ea27" title="Get the expand set for the given rset.">Xapian::Enquire::get_eset()</a>.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="adacae781fdeba5646a1d70055985198"></a><!-- doxytag: member="Xapian::ESet::ESet" ref="adacae781fdeba5646a1d70055985198" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ESet::ESet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct an empty <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>.
<p>
</div>
</div><p>
<a class="anchor" name="8af38835f095c27a544555c6930bee3d"></a><!-- doxytag: member="Xapian::ESet::~ESet" ref="8af38835f095c27a544555c6930bee3d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ESet::~ESet </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>
<a class="anchor" name="576e843f259fb3a6e3f9b18f631daae7"></a><!-- doxytag: member="Xapian::ESet::ESet" ref="576e843f259fb3a6e3f9b18f631daae7" args="(const ESet &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ESet::ESet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ESet.html">ESet</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="c43556828adbf77c352355a9f7fae5ea"></a><!-- doxytag: member="Xapian::ESet::operator=" ref="c43556828adbf77c352355a9f7fae5ea" args="(const ESet &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ESet::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ESet.html">ESet</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="8abc4cffbc1fc9100d1e861fbe1f4002"></a><!-- doxytag: member="Xapian::ESet::get_ebound" ref="8abc4cffbc1fc9100d1e861fbe1f4002" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> Xapian::ESet::get_ebound </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 terms which are in the full set of results of the expand.
<p>
This will be greater than or equal to <a class="el" href="classXapian_1_1ESet.html#d22011cccddf4aff3d2bfb292bed9d42" title="The number of terms in this E-Set.">size()</a>
</div>
</div><p>
<a class="anchor" name="d22011cccddf4aff3d2bfb292bed9d42"></a><!-- doxytag: member="Xapian::ESet::size" ref="d22011cccddf4aff3d2bfb292bed9d42" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> Xapian::ESet::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 terms in this E-Set.
<p>
</div>
</div><p>
<a class="anchor" name="cbb95341846eea1cae721e7b22e3a997"></a><!-- doxytag: member="Xapian::ESet::max_size" ref="cbb95341846eea1cae721e7b22e3a997" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</a> Xapian::ESet::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="9de1a6cdbaac5594178c5b3dc3c4db75"></a><!-- doxytag: member="Xapian::ESet::empty" ref="9de1a6cdbaac5594178c5b3dc3c4db75" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::ESet::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 E-Set is empty.
<p>
</div>
</div><p>
<a class="anchor" name="a70e35b66525da06573b1ac083ff1158"></a><!-- doxytag: member="Xapian::ESet::swap" ref="a70e35b66525da06573b1ac083ff1158" args="(ESet &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ESet::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1ESet.html">ESet</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Swap the E-Set we point to with another.
<p>
</div>
</div><p>
<a class="anchor" name="29ac1edf35733106b404b50568bcca85"></a><!-- doxytag: member="Xapian::ESet::begin" ref="29ac1edf35733106b404b50568bcca85" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESet::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 E-Set.
<p>
</div>
</div><p>
<a class="anchor" name="6db64b05acc483ee1ec33cfae8b4e00d"></a><!-- doxytag: member="Xapian::ESet::end" ref="6db64b05acc483ee1ec33cfae8b4e00d" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESet::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_1ESet.html#29ac1edf35733106b404b50568bcca85" title="Iterator for the terms in this E-Set.">begin()</a>.
<p>
</div>
</div><p>
<a class="anchor" name="7f897ada9435f3599ea6e502edaf637d"></a><!-- doxytag: member="Xapian::ESet::back" ref="7f897ada9435f3599ea6e502edaf637d" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESet::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 E-Set.
<p>
</div>
</div><p>
<a class="anchor" name="b9c5955a45b03298da080c74ab735ced"></a><!-- doxytag: member="Xapian::ESet::operator[]" ref="b9c5955a45b03298da080c74ab735ced" args="(Xapian::termcount i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESet::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#3261017447607738e49eae6a2a4f5eec">Xapian::termcount</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 term at position i in this E-Set.
<p>
</div>
</div><p>
<a class="anchor" name="8a120eb731c621775dcc0803663205bf"></a><!-- doxytag: member="Xapian::ESet::get_description" ref="8a120eb731c621775dcc0803663205bf" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::ESet::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>
