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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::MSet 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_1MSet.html">MSet</a>
</div>
</div>
<div class="contents">
<h1>Xapian::MSet Class Reference</h1><!-- doxytag: class="Xapian::MSet" -->A match set (<a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>).
<a href="#_details">More...</a>
<p>
<p>
<a href="classXapian_1_1MSet-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 Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4231ddc9c8db70ecdd93c321a92e22bd"></a><!-- doxytag: member="Xapian::MSet::value_type" ref="4231ddc9c8db70ecdd93c321a92e22bd" args="" -->
typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#4231ddc9c8db70ecdd93c321a92e22bd">value_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d42cc068683f5617a17c2389aa69e24d"></a><!-- doxytag: member="Xapian::MSet::iterator" ref="d42cc068683f5617a17c2389aa69e24d" args="" -->
typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#d42cc068683f5617a17c2389aa69e24d">iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e1cf112c2a7f10a3e296d880fc7305d"></a><!-- doxytag: member="Xapian::MSet::const_iterator" ref="3e1cf112c2a7f10a3e296d880fc7305d" args="" -->
typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#3e1cf112c2a7f10a3e296d880fc7305d">const_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="96269c51f568b512f75427fbb4adfca1"></a><!-- doxytag: member="Xapian::MSet::reference" ref="96269c51f568b512f75427fbb4adfca1" args="" -->
typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#96269c51f568b512f75427fbb4adfca1">reference</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3f9841ca77ac0b6dbe082a4761e06cc8"></a><!-- doxytag: member="Xapian::MSet::const_reference" ref="3f9841ca77ac0b6dbe082a4761e06cc8" args="" -->
typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#3f9841ca77ac0b6dbe082a4761e06cc8">const_reference</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="152550c0053b1bf0c94c575dfc210a60"></a><!-- doxytag: member="Xapian::MSet::pointer" ref="152550c0053b1bf0c94c575dfc210a60" args="" -->
typedef <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#152550c0053b1bf0c94c575dfc210a60">pointer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ea96beb6135d960f9c4ff1320116508"></a><!-- doxytag: member="Xapian::MSet::difference_type" ref="1ea96beb6135d960f9c4ff1320116508" args="" -->
typedef <a class="el" href="namespaceXapian.html#958ff32fd7a85f2b8a4784ac18397f2b">Xapian::doccount_diff</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#1ea96beb6135d960f9c4ff1320116508">difference_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="425525da26231b848a8845c39fdc22af"></a><!-- doxytag: member="Xapian::MSet::size_type" ref="425525da26231b848a8845c39fdc22af" args="" -->
typedef <a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#425525da26231b848a8845c39fdc22af">size_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL container. <br></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="2731b94a40e99a83c3e5d516809dc2e3"></a><!-- doxytag: member="Xapian::MSet::MSet" ref="2731b94a40e99a83c3e5d516809dc2e3" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#2731b94a40e99a83c3e5d516809dc2e3">MSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="84b1c1a6db62dee0ca1aefadf4ef2d18"></a><!-- doxytag: member="Xapian::MSet::~MSet" ref="84b1c1a6db62dee0ca1aefadf4ef2d18" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#84b1c1a6db62dee0ca1aefadf4ef2d18">~MSet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f94806ac9be50ee0a13d291070645eed"></a><!-- doxytag: member="Xapian::MSet::MSet" ref="f94806ac9be50ee0a13d291070645eed" args="(const MSet &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#f94806ac9be50ee0a13d291070645eed">MSet</a> (const <a class="el" href="classXapian_1_1MSet.html">MSet</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="9f4ba7407c17baa32ce9b3a7cd7d3f05"></a><!-- doxytag: member="Xapian::MSet::operator=" ref="9f4ba7407c17baa32ce9b3a7cd7d3f05" args="(const MSet &other)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#9f4ba7407c17baa32ce9b3a7cd7d3f05">operator=</a> (const <a class="el" href="classXapian_1_1MSet.html">MSet</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#52d96c2df7e63c3fd674e234c0a7c009">fetch</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &begin, const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &end) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the document info for a set of items in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#52d96c2df7e63c3fd674e234c0a7c009"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="367ce5b6d717042d9baf3c4285272add"></a><!-- doxytag: member="Xapian::MSet::fetch" ref="367ce5b6d717042d9baf3c4285272add" args="(const MSetIterator &item) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#367ce5b6d717042d9baf3c4285272add">fetch</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &item) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch the single item specified. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fd639440abc4d569a48b8ff2a88c6e6a"></a><!-- doxytag: member="Xapian::MSet::fetch" ref="fd639440abc4d569a48b8ff2a88c6e6a" args="() const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#fd639440abc4d569a48b8ff2a88c6e6a">fetch</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch all the items in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#22ea0a80c58a2047dd929621b75ed9a2">Xapian::percent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#2211a081b75ebb0c0bd99346a01cb255">convert_to_percent</a> (<a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> wt) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This converts the weight supplied to a percentage score. <a href="#2211a081b75ebb0c0bd99346a01cb255"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c64c6427f73afc9bc3d9ae6d40a4e19"></a><!-- doxytag: member="Xapian::MSet::convert_to_percent" ref="0c64c6427f73afc9bc3d9ae6d40a4e19" args="(const MSetIterator &it) const " -->
<a class="el" href="namespaceXapian.html#22ea0a80c58a2047dd929621b75ed9a2">Xapian::percent</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#0c64c6427f73afc9bc3d9ae6d40a4e19">convert_to_percent</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &it) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the percentage score for a particular item. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#8b53e97c924c671052f14f690061d0ea">get_termfreq</a> (const std::string &tname) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the term frequency of the given query term. <a href="#8b53e97c924c671052f14f690061d0ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#ab7d3fbad74151431e99659b4cd0a016">get_termweight</a> (const std::string &tname) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the term weight of the given query term. <a href="#ab7d3fbad74151431e99659b4cd0a016"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#a347db8d918c7e3b1f2f9e256807229f">get_firstitem</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The index of the first item in the result which was put into the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#a347db8d918c7e3b1f2f9e256807229f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#50eda0fe21978d088b66e63cfb074814">get_matches_lower_bound</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the number of documents in the database which match the query. <a href="#50eda0fe21978d088b66e63cfb074814"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#eab0a82126d9f2cf0ef5321549ea9775">get_matches_estimated</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An estimate for the number of documents in the database which match the query. <a href="#eab0a82126d9f2cf0ef5321549ea9775"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#b7c924c5f2b7e8dee83e533f7a9a7308">get_matches_upper_bound</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the number of documents in the database which match the query. <a href="#b7c924c5f2b7e8dee83e533f7a9a7308"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5c23a4046e1f61302eb141d5445a32d"></a><!-- doxytag: member="Xapian::MSet::get_uncollapsed_matches_lower_bound" ref="c5c23a4046e1f61302eb141d5445a32d" args="() const " -->
<a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#c5c23a4046e1f61302eb141d5445a32d">get_uncollapsed_matches_lower_bound</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the number of documents in the database which would match the query if collapsing wasn't used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb5ac3c2c021a508e99a589f118ba9e5"></a><!-- doxytag: member="Xapian::MSet::get_uncollapsed_matches_estimated" ref="eb5ac3c2c021a508e99a589f118ba9e5" args="() const " -->
<a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#eb5ac3c2c021a508e99a589f118ba9e5">get_uncollapsed_matches_estimated</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A estimate of the number of documents in the database which would match the query if collapsing wasn't used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fe64a64d9d01c5eb046ba22f4a1991c"></a><!-- doxytag: member="Xapian::MSet::get_uncollapsed_matches_upper_bound" ref="3fe64a64d9d01c5eb046ba22f4a1991c" args="() const " -->
<a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#3fe64a64d9d01c5eb046ba22f4a1991c">get_uncollapsed_matches_upper_bound</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A upper bound on the number of documents in the database which would match the query if collapsing wasn't used. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#8317991625dc79949cd6ae52b6dcc920">get_max_possible</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum possible weight in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <a href="#8317991625dc79949cd6ae52b6dcc920"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#8964042d7eeb9e908edd160d07768531">get_max_attained</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The greatest weight which is attained by any document in the database. <a href="#8964042d7eeb9e908edd160d07768531"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b050b4734ab96ea08b4f4b396b03ff9"></a><!-- doxytag: member="Xapian::MSet::size" ref="3b050b4734ab96ea08b4f4b396b03ff9" args="() const " -->
<a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#3b050b4734ab96ea08b4f4b396b03ff9">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of items in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#44c58632455ae84fb0464eb8c1bd3682">max_size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required to allow use as an STL container. <a href="#44c58632455ae84fb0464eb8c1bd3682"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fdd5c88361d0b83fc007a0aef92363b9"></a><!-- doxytag: member="Xapian::MSet::empty" ref="fdd5c88361d0b83fc007a0aef92363b9" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#fdd5c88361d0b83fc007a0aef92363b9">empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> is empty. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8fa74c8d41283fae491f46c690a455cf"></a><!-- doxytag: member="Xapian::MSet::swap" ref="8fa74c8d41283fae491f46c690a455cf" args="(MSet &other)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#8fa74c8d41283fae491f46c690a455cf">swap</a> (<a class="el" href="classXapian_1_1MSet.html">MSet</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Swap the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> we point to with another. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c5ef6da9fd73cede679081be26df41e"></a><!-- doxytag: member="Xapian::MSet::begin" ref="4c5ef6da9fd73cede679081be26df41e" args="() const " -->
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#4c5ef6da9fd73cede679081be26df41e">begin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator for the items in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8fbd9cc68354f519f8773b35d121144b"></a><!-- doxytag: member="Xapian::MSet::end" ref="8fbd9cc68354f519f8773b35d121144b" args="() const " -->
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#8fbd9cc68354f519f8773b35d121144b">end</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End iterator corresponding to <a class="el" href="classXapian_1_1MSet.html#4c5ef6da9fd73cede679081be26df41e" title="Iterator for the items in this MSet.">begin()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28f44ecf0fbfe729d73e9841fe0172e0"></a><!-- doxytag: member="Xapian::MSet::back" ref="28f44ecf0fbfe729d73e9841fe0172e0" args="() const " -->
<a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#28f44ecf0fbfe729d73e9841fe0172e0">back</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator pointing to the last element of this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap 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_1MSet.html#e2da2d1b79ed814652b7c3b3781c2249">operator[]</a> (<a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns the document at position i in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> object. <a href="#e2da2d1b79ed814652b7c3b3781c2249"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78297ec3345af21e915eb061cddca80c"></a><!-- doxytag: member="Xapian::MSet::get_description" ref="78297ec3345af21e915eb061cddca80c" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MSet.html#78297ec3345af21e915eb061cddca80c">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 match set (<a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>).
<p>
This class represents (a portion of) the results of a query. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2211a081b75ebb0c0bd99346a01cb255"></a><!-- doxytag: member="Xapian::MSet::convert_to_percent" ref="2211a081b75ebb0c0bd99346a01cb255" args="(Xapian::weight wt) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#22ea0a80c58a2047dd929621b75ed9a2">Xapian::percent</a> Xapian::MSet::convert_to_percent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> </td>
<td class="paramname"> <em>wt</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This converts the weight supplied to a percentage score.
<p>
The return value will be in the range 0 to 100, and will be 0 if and only if the item did not match the query at all.<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>wt</em> </td><td>The weight to convert. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="52d96c2df7e63c3fd674e234c0a7c009"></a><!-- doxytag: member="Xapian::MSet::fetch" ref="52d96c2df7e63c3fd674e234c0a7c009" args="(const MSetIterator &begin, const MSetIterator &end) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::MSet::fetch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"> <em>end</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fetch the document info for a set of items in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
This method causes the documents in the range specified by the iterators to be fetched from the database, and cached in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a> object. This has little effect when performing a search across a local database, but will greatly speed up subsequent access to the document contents when the documents are stored in a remote database.<p>
The iterators must be over this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">Xapian::MSet</a> - undefined behaviour will result otherwise.<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>begin</em> </td><td><a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> for first item to fetch. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td><a class="el" href="classXapian_1_1MSetIterator.html" title="An iterator pointing to items in an MSet.">MSetIterator</a> for item after last item to fetch. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a347db8d918c7e3b1f2f9e256807229f"></a><!-- doxytag: member="Xapian::MSet::get_firstitem" ref="a347db8d918c7e3b1f2f9e256807229f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSet::get_firstitem </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The index of the first item in the result which was put into the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
This corresponds to the parameter "first" specified in <a class="el" href="classXapian_1_1Enquire.html#edb5fb761acc0bb2249bec375883a093" title="Get (a portion of) the match set for the current query.">Xapian::Enquire::get_mset()</a>. A value of 0 corresponds to the highest result being the first item in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
</div>
</div><p>
<a class="anchor" name="eab0a82126d9f2cf0ef5321549ea9775"></a><!-- doxytag: member="Xapian::MSet::get_matches_estimated" ref="eab0a82126d9f2cf0ef5321549ea9775" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSet::get_matches_estimated </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An estimate for the number of documents in the database which match the query.
<p>
This figure takes into account collapsing of duplicates, and weighting cutoff values.<p>
This value is returned because there is sometimes a request to display such information. However, our experience is that presenting this value to users causes them to worry about the large number of results, rather than how useful those at the top of the result set are, and is thus undesirable.
</div>
</div><p>
<a class="anchor" name="50eda0fe21978d088b66e63cfb074814"></a><!-- doxytag: member="Xapian::MSet::get_matches_lower_bound" ref="50eda0fe21978d088b66e63cfb074814" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSet::get_matches_lower_bound </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 documents in the database which match the query.
<p>
This figure takes into account collapsing of duplicates, and weighting cutoff values.<p>
This number is usually considerably less than the actual number of documents which match the query.
</div>
</div><p>
<a class="anchor" name="b7c924c5f2b7e8dee83e533f7a9a7308"></a><!-- doxytag: member="Xapian::MSet::get_matches_upper_bound" ref="b7c924c5f2b7e8dee83e533f7a9a7308" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSet::get_matches_upper_bound </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An upper bound on the number of documents in the database which match the query.
<p>
This figure takes into account collapsing of duplicates, and weighting cutoff values.<p>
This number is usually considerably greater than the actual number of documents which match the query.
</div>
</div><p>
<a class="anchor" name="8964042d7eeb9e908edd160d07768531"></a><!-- doxytag: member="Xapian::MSet::get_max_attained" ref="8964042d7eeb9e908edd160d07768531" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> Xapian::MSet::get_max_attained </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The greatest weight which is attained by any document in the database.
<p>
If firstitem == 0 and the primary ordering is by relevance, this is the weight of the first entry in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.<p>
If no documents are found by the query, this will be 0.<p>
Note that calculation of max_attained requires calculation of at least one result item - therefore, if no items were requested when the query was performed (by specifying maxitems = 0 in <a class="el" href="classXapian_1_1Enquire.html#edb5fb761acc0bb2249bec375883a093" title="Get (a portion of) the match set for the current query.">Xapian::Enquire::get_mset()</a>), this value will be 0.
</div>
</div><p>
<a class="anchor" name="8317991625dc79949cd6ae52b6dcc920"></a><!-- doxytag: member="Xapian::MSet::get_max_possible" ref="8317991625dc79949cd6ae52b6dcc920" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> Xapian::MSet::get_max_possible </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The maximum possible weight in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
<p>
This weight is likely not to be attained in the set of results, but represents an upper bound on the weight which a document could attain for the given query.
</div>
</div><p>
<a class="anchor" name="8b53e97c924c671052f14f690061d0ea"></a><!-- doxytag: member="Xapian::MSet::get_termfreq" ref="8b53e97c924c671052f14f690061d0ea" args="(const std::string &tname) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSet::get_termfreq </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>tname</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the term frequency of the given query term.
<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>tname</em> </td><td>The term to look for.</td></tr>
</table>
</dl>
This is sometimes more efficient than asking the database directly for the term frequency - in particular, if the term was in the query, its frequency will usually be cached in the <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a>.
</div>
</div><p>
<a class="anchor" name="ab7d3fbad74151431e99659b4cd0a016"></a><!-- doxytag: member="Xapian::MSet::get_termweight" ref="ab7d3fbad74151431e99659b4cd0a016" args="(const std::string &tname) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#cac12803afc9e24ee5141c119acb8884">Xapian::weight</a> Xapian::MSet::get_termweight </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>tname</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the term weight of the given query term.
<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>tname</em> </td><td>The term to look for.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></em> </td><td>is thrown if the term was not in the query. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="44c58632455ae84fb0464eb8c1bd3682"></a><!-- doxytag: member="Xapian::MSet::max_size" ref="44c58632455ae84fb0464eb8c1bd3682" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> Xapian::MSet::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="e2da2d1b79ed814652b7c3b3781c2249"></a><!-- doxytag: member="Xapian::MSet::operator[]" ref="e2da2d1b79ed814652b7c3b3781c2249" args="(Xapian::doccount i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> Xapian::MSet::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#7f30aa95f0c42b117dafaf66ba24241d">Xapian::doccount</a> </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This returns the document at position i in this <a class="el" href="classXapian_1_1MSet.html" title="A match set (MSet).">MSet</a> object.
<p>
Note that this is not the same as the document at rank i in the query, unless the "first" parameter to <a class="el" href="classXapian_1_1Enquire.html#edb5fb761acc0bb2249bec375883a093" title="Get (a portion of) the match set for the current query.">Xapian::Enquire::get_mset</a> was 0. Rather, it is the document at rank i + first.<p>
In other words, the offset is into the documents represented by this object, not into the set of documents matching the query.<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_1MSet.html" title="A match set (MSet).">MSet</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>
|
