1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<!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.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_1ESet.html">ESet</a>
</div>
</div>
<div class="contents">
<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>
<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"><a class="anchor" name="b53f2936cfa1c16c7ea4e171d7572e02"></a><!-- doxytag: member="Xapian::ESet::ESet" ref="b53f2936cfa1c16c7ea4e171d7572e02" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#b53f2936cfa1c16c7ea4e171d7572e02">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>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="07720954f3b74b0378079eb947be7642"></a><!-- doxytag: member="Xapian::ESet::~ESet" ref="07720954f3b74b0378079eb947be7642" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#07720954f3b74b0378079eb947be7642">~ESet</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="817bfddb94d57028fefe678b5f614c5a"></a><!-- doxytag: member="Xapian::ESet::ESet" ref="817bfddb94d57028fefe678b5f614c5a" args="(const ESet &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#817bfddb94d57028fefe678b5f614c5a">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). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="626192324d2199ff59b2b7380371aba9"></a><!-- doxytag: member="Xapian::ESet::operator=" ref="626192324d2199ff59b2b7380371aba9" args="(const ESet &other)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#626192324d2199ff59b2b7380371aba9">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). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#2679dc65b4448d98d928daccecc2c5bd">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="#2679dc65b4448d98d928daccecc2c5bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ebe586b9f270b318589f77b03841c420"></a><!-- doxytag: member="Xapian::ESet::size" ref="ebe586b9f270b318589f77b03841c420" args="() const " -->
<a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#ebe586b9f270b318589f77b03841c420">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of terms in this E-Set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#6e96fb499d2a2ea8e9846853f8f043e0">max_size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required to allow use as an STL container. <a href="#6e96fb499d2a2ea8e9846853f8f043e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="090e0af57f0c7dc00dba7f3f86421674"></a><!-- doxytag: member="Xapian::ESet::empty" ref="090e0af57f0c7dc00dba7f3f86421674" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#090e0af57f0c7dc00dba7f3f86421674">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this E-Set is empty. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2c3235a5e0ac8aad189ab0ef987a049"></a><!-- doxytag: member="Xapian::ESet::swap" ref="d2c3235a5e0ac8aad189ab0ef987a049" args="(ESet &other)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#d2c3235a5e0ac8aad189ab0ef987a049">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. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b372abbea446e55668623da2640a2979"></a><!-- doxytag: member="Xapian::ESet::begin" ref="b372abbea446e55668623da2640a2979" args="() const " -->
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#b372abbea446e55668623da2640a2979">begin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator for the terms in this E-Set. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4a4fc608e5b1e98fa7fdd9ab5e5569e"></a><!-- doxytag: member="Xapian::ESet::end" ref="b4a4fc608e5b1e98fa7fdd9ab5e5569e" args="() const " -->
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#b4a4fc608e5b1e98fa7fdd9ab5e5569e">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#b372abbea446e55668623da2640a2979" title="Iterator for the terms in this E-Set.">begin()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4ff820f027bf26c338b106ed1b46704"></a><!-- doxytag: member="Xapian::ESet::back" ref="d4ff820f027bf26c338b106ed1b46704" args="() const " -->
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#d4ff820f027bf26c338b106ed1b46704">back</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator pointing to the last element of this E-Set. <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#774ae93e1065b7d2ccd75da52e3fd5ae">operator[]</a> (<a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">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="#774ae93e1065b7d2ccd75da52e3fd5ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d63a1c7299c538001212e4ecd0bb5bc1"></a><!-- doxytag: member="Xapian::ESet::get_description" ref="d63a1c7299c538001212e4ecd0bb5bc1" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#d63a1c7299c538001212e4ecd0bb5bc1">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>
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#c04aa26eff82db9fd810b8125a31ee55" title="Get the expand set for the given rset.">Xapian::Enquire::get_eset()</a>. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2679dc65b4448d98d928daccecc2c5bd"></a><!-- doxytag: member="Xapian::ESet::get_ebound" ref="2679dc65b4448d98d928daccecc2c5bd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> Xapian::ESet::get_ebound </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> 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#ebe586b9f270b318589f77b03841c420" title="The number of terms in this E-Set.">size()</a>
</div>
</div><p>
<a class="anchor" name="6e96fb499d2a2ea8e9846853f8f043e0"></a><!-- doxytag: member="Xapian::ESet::max_size" ref="6e96fb499d2a2ea8e9846853f8f043e0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> Xapian::ESet::max_size </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> 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="774ae93e1065b7d2ccd75da52e3fd5ae"></a><!-- doxytag: member="Xapian::ESet::operator[]" ref="774ae93e1065b7d2ccd75da52e3fd5ae" 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#72b5a76dd8cfb7b251fe7986e86390cb">Xapian::termcount</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This returns the term at position i in this E-Set.
<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>i</em> </td><td>The index into the <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>. </td></tr>
</table>
</dl>
</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>
</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>
|
