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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::MSetIterator 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.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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_1MSetIterator.html">MSetIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1MSetIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::MSetIterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Iterator over a <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results. ">Xapian::MSet</a>.
<a href="classXapian_1_1MSetIterator.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:a24089616ca88737d235d50fe39c10a5b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a24089616ca88737d235d50fe39c10a5b">MSetIterator</a> ()</td></tr>
<tr class="memdesc:a24089616ca88737d235d50fe39c10a5b"><td class="mdescLeft"> </td><td class="mdescRight">Create an unpositioned <a class="el" href="classXapian_1_1MSetIterator.html" title="Iterator over a Xapian::MSet. ">MSetIterator</a>. <a href="#a24089616ca88737d235d50fe39c10a5b">More...</a><br /></td></tr>
<tr class="separator:a24089616ca88737d235d50fe39c10a5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcce6cb40ff3603e46332128aa1afce8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#adcce6cb40ff3603e46332128aa1afce8">operator*</a> () const</td></tr>
<tr class="memdesc:adcce6cb40ff3603e46332128aa1afce8"><td class="mdescLeft"> </td><td class="mdescRight">Get the numeric document id for the current position. <a href="#adcce6cb40ff3603e46332128aa1afce8">More...</a><br /></td></tr>
<tr class="separator:adcce6cb40ff3603e46332128aa1afce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4ac6e0c3cac3be285be16b1bf5bf490"><td class="memItemLeft" align="right" valign="top"><a id="ad4ac6e0c3cac3be285be16b1bf5bf490"></a>
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#ad4ac6e0c3cac3be285be16b1bf5bf490">operator++</a> ()</td></tr>
<tr class="memdesc:ad4ac6e0c3cac3be285be16b1bf5bf490"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position. <br /></td></tr>
<tr class="separator:ad4ac6e0c3cac3be285be16b1bf5bf490"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa449795683d7ffe7387db58373d6fee"><td class="memItemLeft" align="right" valign="top"><a id="afa449795683d7ffe7387db58373d6fee"></a>
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#afa449795683d7ffe7387db58373d6fee">operator++</a> (int)</td></tr>
<tr class="memdesc:afa449795683d7ffe7387db58373d6fee"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position (postfix version). <br /></td></tr>
<tr class="separator:afa449795683d7ffe7387db58373d6fee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b904a30ffcd05700a908ee7e9645a61"><td class="memItemLeft" align="right" valign="top"><a id="a4b904a30ffcd05700a908ee7e9645a61"></a>
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a4b904a30ffcd05700a908ee7e9645a61">operator--</a> ()</td></tr>
<tr class="memdesc:a4b904a30ffcd05700a908ee7e9645a61"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator to the previous position. <br /></td></tr>
<tr class="separator:a4b904a30ffcd05700a908ee7e9645a61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adadef547ef6a82c35d6a78b2187a56c4"><td class="memItemLeft" align="right" valign="top"><a id="adadef547ef6a82c35d6a78b2187a56c4"></a>
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#adadef547ef6a82c35d6a78b2187a56c4">operator--</a> (int)</td></tr>
<tr class="memdesc:adadef547ef6a82c35d6a78b2187a56c4"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator to the previous position (postfix version). <br /></td></tr>
<tr class="separator:adadef547ef6a82c35d6a78b2187a56c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a213e4a34e45d231fe5a8505fa4014bba"><td class="memItemLeft" align="right" valign="top"><a id="a213e4a34e45d231fe5a8505fa4014bba"></a>
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a213e4a34e45d231fe5a8505fa4014bba">operator+=</a> (difference_type n)</td></tr>
<tr class="memdesc:a213e4a34e45d231fe5a8505fa4014bba"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator forwards by n positions. <br /></td></tr>
<tr class="separator:a213e4a34e45d231fe5a8505fa4014bba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5795d4d9f096d9f63389bae38e73992b"><td class="memItemLeft" align="right" valign="top"><a id="a5795d4d9f096d9f63389bae38e73992b"></a>
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a5795d4d9f096d9f63389bae38e73992b">operator-=</a> (difference_type n)</td></tr>
<tr class="memdesc:a5795d4d9f096d9f63389bae38e73992b"><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator back by n positions. <br /></td></tr>
<tr class="separator:a5795d4d9f096d9f63389bae38e73992b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d61b81d1f66ff9a82920f0cfa27ed5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a8d61b81d1f66ff9a82920f0cfa27ed5a">operator+</a> (difference_type n) const</td></tr>
<tr class="memdesc:a8d61b81d1f66ff9a82920f0cfa27ed5a"><td class="mdescLeft"> </td><td class="mdescRight">Return the iterator incremented by <em>n</em> positions. <a href="#a8d61b81d1f66ff9a82920f0cfa27ed5a">More...</a><br /></td></tr>
<tr class="separator:a8d61b81d1f66ff9a82920f0cfa27ed5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0756f6de2f7cd27337a12d0f299c5b90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a0756f6de2f7cd27337a12d0f299c5b90">operator-</a> (difference_type n) const</td></tr>
<tr class="memdesc:a0756f6de2f7cd27337a12d0f299c5b90"><td class="mdescLeft"> </td><td class="mdescRight">Return the iterator decremented by <em>n</em> positions. <a href="#a0756f6de2f7cd27337a12d0f299c5b90">More...</a><br /></td></tr>
<tr class="separator:a0756f6de2f7cd27337a12d0f299c5b90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb076feba1ac61cb9334e1ff67f9d511"><td class="memItemLeft" align="right" valign="top">difference_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#adb076feba1ac61cb9334e1ff67f9d511">operator-</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &o) const</td></tr>
<tr class="memdesc:adb076feba1ac61cb9334e1ff67f9d511"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of positions between <em>o</em> and this iterator. <a href="#adb076feba1ac61cb9334e1ff67f9d511">More...</a><br /></td></tr>
<tr class="separator:adb076feba1ac61cb9334e1ff67f9d511"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45c5fd6195cbf515bea98bc00f3ad81d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a45c5fd6195cbf515bea98bc00f3ad81d">get_rank</a> () const</td></tr>
<tr class="memdesc:a45c5fd6195cbf515bea98bc00f3ad81d"><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results. ">MSet</a> rank for the current position. <a href="#a45c5fd6195cbf515bea98bc00f3ad81d">More...</a><br /></td></tr>
<tr class="separator:a45c5fd6195cbf515bea98bc00f3ad81d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8823828d9403bb7d46baaac00524b02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#ae8823828d9403bb7d46baaac00524b02">get_document</a> () const</td></tr>
<tr class="memdesc:ae8823828d9403bb7d46baaac00524b02"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Document</a> object for the current position. <a href="#ae8823828d9403bb7d46baaac00524b02">More...</a><br /></td></tr>
<tr class="separator:ae8823828d9403bb7d46baaac00524b02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaab3f59a87ba89afffe3375bd33a59ca"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#aaab3f59a87ba89afffe3375bd33a59ca">get_weight</a> () const</td></tr>
<tr class="memdesc:aaab3f59a87ba89afffe3375bd33a59ca"><td class="mdescLeft"> </td><td class="mdescRight">Get the weight for the current position. <a href="#aaab3f59a87ba89afffe3375bd33a59ca">More...</a><br /></td></tr>
<tr class="separator:aaab3f59a87ba89afffe3375bd33a59ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82d85bda75f6b5291cb25e3450aa5a82"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a82d85bda75f6b5291cb25e3450aa5a82">get_collapse_key</a> () const</td></tr>
<tr class="memdesc:a82d85bda75f6b5291cb25e3450aa5a82"><td class="mdescLeft"> </td><td class="mdescRight">Return the collapse key for the current position. <a href="#a82d85bda75f6b5291cb25e3450aa5a82">More...</a><br /></td></tr>
<tr class="separator:a82d85bda75f6b5291cb25e3450aa5a82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab21f70982efb0250298eea00284313a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#ab21f70982efb0250298eea00284313a8">get_collapse_count</a> () const</td></tr>
<tr class="memdesc:ab21f70982efb0250298eea00284313a8"><td class="mdescLeft"> </td><td class="mdescRight">Return a count of the number of collapses done onto the current key. <a href="#ab21f70982efb0250298eea00284313a8">More...</a><br /></td></tr>
<tr class="separator:ab21f70982efb0250298eea00284313a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f7ae602dc6d2311d8298b24bef3c95c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#a4f7ae602dc6d2311d8298b24bef3c95c">get_percent</a> () const</td></tr>
<tr class="memdesc:a4f7ae602dc6d2311d8298b24bef3c95c"><td class="mdescLeft"> </td><td class="mdescRight">Convert the weight of the current iterator position to a percentage. <a href="#a4f7ae602dc6d2311d8298b24bef3c95c">More...</a><br /></td></tr>
<tr class="separator:a4f7ae602dc6d2311d8298b24bef3c95c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af874aa64d7aac96b9177589684b4f066"><td class="memItemLeft" align="right" valign="top"><a id="af874aa64d7aac96b9177589684b4f066"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSetIterator.html#af874aa64d7aac96b9177589684b4f066">get_description</a> () const</td></tr>
<tr class="memdesc:af874aa64d7aac96b9177589684b4f066"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:af874aa64d7aac96b9177589684b4f066"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Iterator over a <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results. ">Xapian::MSet</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a24089616ca88737d235d50fe39c10a5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24089616ca88737d235d50fe39c10a5b">◆ </a></span>MSetIterator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::MSetIterator::MSetIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an unpositioned <a class="el" href="classXapian_1_1MSetIterator.html" title="Iterator over a Xapian::MSet. ">MSetIterator</a>. </p>
<p class="reference">References <a class="el" href="namespaceXapian.html#ad6c424a7b62b804bd350412ffcd01a6d">Xapian::operator*()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab21f70982efb0250298eea00284313a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab21f70982efb0250298eea00284313a8">◆ </a></span>get_collapse_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> Xapian::MSetIterator::get_collapse_count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a count of the number of collapses done onto the current key. </p>
<p>This starts at 0, and is incremented each time an item is eliminated because its key is the same as that of the current item (as returned by <a class="el" href="classXapian_1_1MSetIterator.html#a82d85bda75f6b5291cb25e3450aa5a82" title="Return the collapse key for the current position. ">get_collapse_key()</a>).</p>
<p>Note that this is NOT necessarily one less than the total number of matching documents with this collapse key due to various optimisations implemented in the matcher - for example, it can skip documents completely if it can prove their weight wouldn't be enough to make the result set.</p>
<p>You can say is that if <a class="el" href="classXapian_1_1MSetIterator.html#ab21f70982efb0250298eea00284313a8" title="Return a count of the number of collapses done onto the current key. ">get_collapse_count()</a> > 0 then there are >= <a class="el" href="classXapian_1_1MSetIterator.html#ab21f70982efb0250298eea00284313a8" title="Return a count of the number of collapses done onto the current key. ">get_collapse_count()</a> other documents with the current collapse key. But if <a class="el" href="classXapian_1_1MSetIterator.html#ab21f70982efb0250298eea00284313a8" title="Return a count of the number of collapses done onto the current key. ">get_collapse_count()</a> == 0 then there may or may not be other such documents. </p>
</div>
</div>
<a id="a82d85bda75f6b5291cb25e3450aa5a82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82d85bda75f6b5291cb25e3450aa5a82">◆ </a></span>get_collapse_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::MSetIterator::get_collapse_key </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the collapse key for the current position. </p>
<p>If collapsing isn't in use, an empty string will be returned. </p>
</div>
</div>
<a id="ae8823828d9403bb7d46baaac00524b02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8823828d9403bb7d46baaac00524b02">◆ </a></span>get_document()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> Xapian::MSetIterator::get_document </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Document</a> object for the current position. </p>
</div>
</div>
<a id="a4f7ae602dc6d2311d8298b24bef3c95c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f7ae602dc6d2311d8298b24bef3c95c">◆ </a></span>get_percent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Xapian::MSetIterator::get_percent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert the weight of the current iterator position to a percentage. </p>
<p>The matching document with the highest weight will get 100% if it matches all the weighted query terms, and proportionally less if it only matches some, and other weights are scaled by the same factor.</p>
<p>Documents with a non-zero score will always score at least 1%.</p>
<p>Note that these generally aren't percentages of anything meaningful (unless you use a custom weighting formula where they are!) </p>
<p class="reference">References <a class="el" href="classXapian_1_1MSet.html#a6f834ac35fdcc58fcd5eb38fc7f320f1">Xapian::MSet::convert_to_percent()</a>.</p>
</div>
</div>
<a id="a45c5fd6195cbf515bea98bc00f3ad81d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45c5fd6195cbf515bea98bc00f3ad81d">◆ </a></span>get_rank()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> Xapian::MSetIterator::get_rank </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results. ">MSet</a> rank for the current position. </p>
<p>The rank of mset[0] is mset.get_firstitem(). </p>
<p class="reference">References <a class="el" href="classXapian_1_1MSet.html#a8a8acbf405fc883ccd11823743f1d8a3">Xapian::MSet::get_firstitem()</a>, and <a class="el" href="classXapian_1_1MSet.html#a2181d1574210c9b600775a309aebbf49">Xapian::MSet::size()</a>.</p>
</div>
</div>
<a id="aaab3f59a87ba89afffe3375bd33a59ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaab3f59a87ba89afffe3375bd33a59ca">◆ </a></span>get_weight()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Xapian::MSetIterator::get_weight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the weight for the current position. </p>
<p class="reference">Referenced by <a class="el" href="classXapian_1_1MSet.html#a610feaa8b1278bcd73510cec7f0deabf">Xapian::MSet::convert_to_percent()</a>.</p>
</div>
</div>
<a id="adcce6cb40ff3603e46332128aa1afce8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcce6cb40ff3603e46332128aa1afce8">◆ </a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> Xapian::MSetIterator::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the numeric document id for the current position. </p>
</div>
</div>
<a id="a8d61b81d1f66ff9a82920f0cfa27ed5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d61b81d1f66ff9a82920f0cfa27ed5a">◆ </a></span>operator+()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> Xapian::MSetIterator::operator+ </td>
<td>(</td>
<td class="paramtype">difference_type </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the iterator incremented by <em>n</em> positions. </p>
<p>If <em>n</em> is negative, decrements by (-n) positions. </p>
</div>
</div>
<a id="a0756f6de2f7cd27337a12d0f299c5b90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0756f6de2f7cd27337a12d0f299c5b90">◆ </a></span>operator-() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> Xapian::MSetIterator::operator- </td>
<td>(</td>
<td class="paramtype">difference_type </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the iterator decremented by <em>n</em> positions. </p>
<p>If <em>n</em> is negative, increments by (-n) positions. </p>
</div>
</div>
<a id="adb076feba1ac61cb9334e1ff67f9d511"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb076feba1ac61cb9334e1ff67f9d511">◆ </a></span>operator-() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">difference_type Xapian::MSetIterator::operator- </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of positions between <em>o</em> and this iterator. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="mset_8h.html">mset.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<address><small>
Documentation for Xapian (version 1.4.3).<br>
Generated on Wed Jan 25 2017 by
<a href="http://www.doxygen.org/">Doxygen 1.8.13</a>.
</small></address>
</body>
</html>
|
