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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::ESet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">xapian-core
 <span id="projectnumber">1.4.18</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1ESet.html">ESet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1ESet-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::ESet Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class representing a list of search results.
<a href="classXapian_1_1ESet.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad5632910e0eb8c7e479cd185475722d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#ad5632910e0eb8c7e479cd185475722d8">ESet</a> (const <a class="el" href="classXapian_1_1ESet.html">ESet</a> &o)</td></tr>
<tr class="memdesc:ad5632910e0eb8c7e479cd185475722d8"><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="classXapian_1_1ESet.html#ad5632910e0eb8c7e479cd185475722d8">More...</a><br /></td></tr>
<tr class="separator:ad5632910e0eb8c7e479cd185475722d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe5c298efad5dc5dd2c32046cf3a9702"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ESet.html">ESet</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#afe5c298efad5dc5dd2c32046cf3a9702">operator=</a> (const <a class="el" href="classXapian_1_1ESet.html">ESet</a> &o)</td></tr>
<tr class="memdesc:afe5c298efad5dc5dd2c32046cf3a9702"><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="classXapian_1_1ESet.html#afe5c298efad5dc5dd2c32046cf3a9702">More...</a><br /></td></tr>
<tr class="separator:afe5c298efad5dc5dd2c32046cf3a9702"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab53f2936cfa1c16c7ea4e171d7572e02"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#ab53f2936cfa1c16c7ea4e171d7572e02">ESet</a> ()</td></tr>
<tr class="memdesc:ab53f2936cfa1c16c7ea4e171d7572e02"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="classXapian_1_1ESet.html#ab53f2936cfa1c16c7ea4e171d7572e02">More...</a><br /></td></tr>
<tr class="separator:ab53f2936cfa1c16c7ea4e171d7572e02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07720954f3b74b0378079eb947be7642"><td class="memItemLeft" align="right" valign="top"><a id="a07720954f3b74b0378079eb947be7642"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#a07720954f3b74b0378079eb947be7642">~ESet</a> ()</td></tr>
<tr class="memdesc:a07720954f3b74b0378079eb947be7642"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a07720954f3b74b0378079eb947be7642"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9429dc27f273b71db70c763d24a0cb9e"><td class="memItemLeft" align="right" valign="top"><a id="a9429dc27f273b71db70c763d24a0cb9e"></a>
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#a9429dc27f273b71db70c763d24a0cb9e">size</a> () const</td></tr>
<tr class="memdesc:a9429dc27f273b71db70c763d24a0cb9e"><td class="mdescLeft"> </td><td class="mdescRight">Return number of items in this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object. <br /></td></tr>
<tr class="separator:a9429dc27f273b71db70c763d24a0cb9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd450fec51d9b7ecfcefcef64955b982"><td class="memItemLeft" align="right" valign="top"><a id="acd450fec51d9b7ecfcefcef64955b982"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#acd450fec51d9b7ecfcefcef64955b982">empty</a> () const</td></tr>
<tr class="memdesc:acd450fec51d9b7ecfcefcef64955b982"><td class="mdescLeft"> </td><td class="mdescRight">Return true if this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object is empty. <br /></td></tr>
<tr class="separator:acd450fec51d9b7ecfcefcef64955b982"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4eeaf9261f797f2ff48d1be1fdf7c96e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#a4eeaf9261f797f2ff48d1be1fdf7c96e">get_ebound</a> () const</td></tr>
<tr class="memdesc:a4eeaf9261f797f2ff48d1be1fdf7c96e"><td class="mdescLeft"> </td><td class="mdescRight">Return a bound on the full size of this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object. <a href="classXapian_1_1ESet.html#a4eeaf9261f797f2ff48d1be1fdf7c96e">More...</a><br /></td></tr>
<tr class="separator:a4eeaf9261f797f2ff48d1be1fdf7c96e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6f6e93a6ef018fea6cb10963aff41e8"><td class="memItemLeft" align="right" valign="top"><a id="ac6f6e93a6ef018fea6cb10963aff41e8"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#ac6f6e93a6ef018fea6cb10963aff41e8">swap</a> (<a class="el" href="classXapian_1_1ESet.html">ESet</a> &o)</td></tr>
<tr class="memdesc:ac6f6e93a6ef018fea6cb10963aff41e8"><td class="mdescLeft"> </td><td class="mdescRight">Efficiently swap this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object with another. <br /></td></tr>
<tr class="separator:ac6f6e93a6ef018fea6cb10963aff41e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc4ccb6b22e85e67876e17294c750ea8"><td class="memItemLeft" align="right" valign="top"><a id="afc4ccb6b22e85e67876e17294c750ea8"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#afc4ccb6b22e85e67876e17294c750ea8">begin</a> () const</td></tr>
<tr class="memdesc:afc4ccb6b22e85e67876e17294c750ea8"><td class="mdescLeft"> </td><td class="mdescRight">Return iterator pointing to the first item in this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a>. <br /></td></tr>
<tr class="separator:afc4ccb6b22e85e67876e17294c750ea8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60b2697ff8af55edec87f1fb0d57a5ea"><td class="memItemLeft" align="right" valign="top"><a id="a60b2697ff8af55edec87f1fb0d57a5ea"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#a60b2697ff8af55edec87f1fb0d57a5ea">end</a> () const</td></tr>
<tr class="memdesc:a60b2697ff8af55edec87f1fb0d57a5ea"><td class="mdescLeft"> </td><td class="mdescRight">Return iterator pointing to just after the last item in this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a>. <br /></td></tr>
<tr class="separator:a60b2697ff8af55edec87f1fb0d57a5ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a546d4228b1bdc2766e101198e74e1bb4"><td class="memItemLeft" align="right" valign="top"><a id="a546d4228b1bdc2766e101198e74e1bb4"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#a546d4228b1bdc2766e101198e74e1bb4">operator[]</a> (<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> i) const</td></tr>
<tr class="memdesc:a546d4228b1bdc2766e101198e74e1bb4"><td class="mdescLeft"> </td><td class="mdescRight">Return iterator pointing to the i-th object in this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a>. <br /></td></tr>
<tr class="separator:a546d4228b1bdc2766e101198e74e1bb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a407b1f8db39d99cfe999da61d0e1b412"><td class="memItemLeft" align="right" valign="top"><a id="a407b1f8db39d99cfe999da61d0e1b412"></a>
<a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#a407b1f8db39d99cfe999da61d0e1b412">back</a> () const</td></tr>
<tr class="memdesc:a407b1f8db39d99cfe999da61d0e1b412"><td class="mdescLeft"> </td><td class="mdescRight">Return iterator pointing to the last object in this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a>. <br /></td></tr>
<tr class="separator:a407b1f8db39d99cfe999da61d0e1b412"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a088e9d714785c50eb0c2619519ed0859"><td class="memItemLeft" align="right" valign="top"><a id="a088e9d714785c50eb0c2619519ed0859"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESet.html#a088e9d714785c50eb0c2619519ed0859">get_description</a> () const</td></tr>
<tr class="memdesc:a088e9d714785c50eb0c2619519ed0859"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a088e9d714785c50eb0c2619519ed0859"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class representing a list of search results. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad5632910e0eb8c7e479cd185475722d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5632910e0eb8c7e479cd185475722d8">◆ </a></span>ESet() <span class="overload">[1/2]</span></h2>
<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>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copying is allowed. </p>
<p>The internals are reference counted, so copying is cheap. </p>
</div>
</div>
<a id="ab53f2936cfa1c16c7ea4e171d7572e02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab53f2936cfa1c16c7ea4e171d7572e02">◆ </a></span>ESet() <span class="overload">[2/2]</span></h2>
<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></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>Creates an empty <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a>, mostly useful as a placeholder. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4eeaf9261f797f2ff48d1be1fdf7c96e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eeaf9261f797f2ff48d1be1fdf7c96e">◆ </a></span>get_ebound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">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>Return a bound on the full size of this <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object. </p>
<p>This is a bound on <a class="el" href="classXapian_1_1ESet.html#a9429dc27f273b71db70c763d24a0cb9e" title="Return number of items in this ESet object.">size()</a> if get_eset() had been called with maxitems set high enough that all results were returned. </p>
</div>
</div>
<a id="afe5c298efad5dc5dd2c32046cf3a9702"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe5c298efad5dc5dd2c32046cf3a9702">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESet.html">ESet</a>& 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>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copying is allowed. </p>
<p>The internals are reference counted, so assignment is cheap. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="eset_8h.html">eset.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.1</a>
</small></address>
</body>
</html>
|
