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
542
543
544
545
546
547
548
549
550
551
|
<!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::ValueMapPostingSource 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_1ValueMapPostingSource.html">ValueMapPostingSource</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1ValueMapPostingSource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::ValueMapPostingSource Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A posting source which looks up weights in a map using values as the key.
<a href="classXapian_1_1ValueMapPostingSource.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::ValueMapPostingSource:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classXapian_1_1ValueMapPostingSource__inherit__graph.png" border="0" usemap="#aXapian_1_1ValueMapPostingSource_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1ValueMapPostingSource_inherit__map" id="aXapian_1_1ValueMapPostingSource_inherit__map">
<area shape="rect" title="A posting source which looks up weights in a map using values as the key." alt="" coords="5,244,237,271"/>
<area shape="rect" href="classXapian_1_1ValuePostingSource.html" title="A posting source which generates weights from a value slot." alt="" coords="19,169,223,196"/>
<area shape="rect" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings." alt="" coords="38,95,205,121"/>
<area shape="rect" title=" " alt="" coords="44,5,199,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:aef9518eab055c5f1d3bea3fb8df4368f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#aef9518eab055c5f1d3bea3fb8df4368f">ValueMapPostingSource</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_)</td></tr>
<tr class="memdesc:aef9518eab055c5f1d3bea3fb8df4368f"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1ValueMapPostingSource.html" title="A posting source which looks up weights in a map using values as the key.">ValueMapPostingSource</a>. <a href="classXapian_1_1ValueMapPostingSource.html#aef9518eab055c5f1d3bea3fb8df4368f">More...</a><br /></td></tr>
<tr class="separator:aef9518eab055c5f1d3bea3fb8df4368f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a126c88575ad8f06c850826ac7cd2a591"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#a126c88575ad8f06c850826ac7cd2a591">add_mapping</a> (const std::string &key, double wt)</td></tr>
<tr class="memdesc:a126c88575ad8f06c850826ac7cd2a591"><td class="mdescLeft"> </td><td class="mdescRight">Add a mapping. <a href="classXapian_1_1ValueMapPostingSource.html#a126c88575ad8f06c850826ac7cd2a591">More...</a><br /></td></tr>
<tr class="separator:a126c88575ad8f06c850826ac7cd2a591"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f41218d580d29681e748a7d25aad8aa"><td class="memItemLeft" align="right" valign="top"><a id="a4f41218d580d29681e748a7d25aad8aa"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#a4f41218d580d29681e748a7d25aad8aa">clear_mappings</a> ()</td></tr>
<tr class="memdesc:a4f41218d580d29681e748a7d25aad8aa"><td class="mdescLeft"> </td><td class="mdescRight">Clear all mappings. <br /></td></tr>
<tr class="separator:a4f41218d580d29681e748a7d25aad8aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a895c2f710b42bf93f71d0321225dc38f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#a895c2f710b42bf93f71d0321225dc38f">set_default_weight</a> (double wt)</td></tr>
<tr class="memdesc:a895c2f710b42bf93f71d0321225dc38f"><td class="mdescLeft"> </td><td class="mdescRight">Set a default weight for document values not in the map. <a href="classXapian_1_1ValueMapPostingSource.html#a895c2f710b42bf93f71d0321225dc38f">More...</a><br /></td></tr>
<tr class="separator:a895c2f710b42bf93f71d0321225dc38f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e5ea4b5005d05933c1526d65cd3a18d"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#a2e5ea4b5005d05933c1526d65cd3a18d">get_weight</a> () const</td></tr>
<tr class="memdesc:a2e5ea4b5005d05933c1526d65cd3a18d"><td class="mdescLeft"> </td><td class="mdescRight">Return the weight contribution for the current document. <a href="classXapian_1_1ValueMapPostingSource.html#a2e5ea4b5005d05933c1526d65cd3a18d">More...</a><br /></td></tr>
<tr class="separator:a2e5ea4b5005d05933c1526d65cd3a18d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51b59d9f2126aa925a140f7fd77eef5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ValueMapPostingSource.html">ValueMapPostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#a51b59d9f2126aa925a140f7fd77eef5e">clone</a> () const</td></tr>
<tr class="memdesc:a51b59d9f2126aa925a140f7fd77eef5e"><td class="mdescLeft"> </td><td class="mdescRight">Clone the posting source. <a href="classXapian_1_1ValueMapPostingSource.html#a51b59d9f2126aa925a140f7fd77eef5e">More...</a><br /></td></tr>
<tr class="separator:a51b59d9f2126aa925a140f7fd77eef5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f20f584f45a63b14cd84f8ccb24b90d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#a3f20f584f45a63b14cd84f8ccb24b90d">name</a> () const</td></tr>
<tr class="memdesc:a3f20f584f45a63b14cd84f8ccb24b90d"><td class="mdescLeft"> </td><td class="mdescRight">Name of the posting source class. <a href="classXapian_1_1ValueMapPostingSource.html#a3f20f584f45a63b14cd84f8ccb24b90d">More...</a><br /></td></tr>
<tr class="separator:a3f20f584f45a63b14cd84f8ccb24b90d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd71690574ee0f180a2c82c14f4715e7"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#abd71690574ee0f180a2c82c14f4715e7">serialise</a> () const</td></tr>
<tr class="memdesc:abd71690574ee0f180a2c82c14f4715e7"><td class="mdescLeft"> </td><td class="mdescRight">Serialise object parameters into a string. <a href="classXapian_1_1ValueMapPostingSource.html#abd71690574ee0f180a2c82c14f4715e7">More...</a><br /></td></tr>
<tr class="separator:abd71690574ee0f180a2c82c14f4715e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af79239d7dfee4de571253fdfd3b95020"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ValueMapPostingSource.html">ValueMapPostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#af79239d7dfee4de571253fdfd3b95020">unserialise</a> (const std::string &serialised) const</td></tr>
<tr class="memdesc:af79239d7dfee4de571253fdfd3b95020"><td class="mdescLeft"> </td><td class="mdescRight">Create object given string serialisation returned by <a class="el" href="classXapian_1_1ValueMapPostingSource.html#abd71690574ee0f180a2c82c14f4715e7" title="Serialise object parameters into a string.">serialise()</a>. <a href="classXapian_1_1ValueMapPostingSource.html#af79239d7dfee4de571253fdfd3b95020">More...</a><br /></td></tr>
<tr class="separator:af79239d7dfee4de571253fdfd3b95020"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae76de9cb534e96b7a0cc827d89eea8fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#ae76de9cb534e96b7a0cc827d89eea8fc">init</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &db_)</td></tr>
<tr class="memdesc:ae76de9cb534e96b7a0cc827d89eea8fc"><td class="mdescLeft"> </td><td class="mdescRight">Set this <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> to the start of the list of postings. <a href="classXapian_1_1ValueMapPostingSource.html#ae76de9cb534e96b7a0cc827d89eea8fc">More...</a><br /></td></tr>
<tr class="separator:ae76de9cb534e96b7a0cc827d89eea8fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab570a48cdfe41b3c9f9203caddc7fccb"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueMapPostingSource.html#ab570a48cdfe41b3c9f9203caddc7fccb">get_description</a> () const</td></tr>
<tr class="memdesc:ab570a48cdfe41b3c9f9203caddc7fccb"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="classXapian_1_1ValueMapPostingSource.html#ab570a48cdfe41b3c9f9203caddc7fccb">More...</a><br /></td></tr>
<tr class="separator:ab570a48cdfe41b3c9f9203caddc7fccb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1ValuePostingSource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1ValuePostingSource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1ValuePostingSource.html">Xapian::ValuePostingSource</a></td></tr>
<tr class="memitem:accbffc6b7f573e9a41fc234a410a1ec3 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#accbffc6b7f573e9a41fc234a410a1ec3">ValuePostingSource</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_)</td></tr>
<tr class="memdesc:accbffc6b7f573e9a41fc234a410a1ec3 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1ValuePostingSource.html" title="A posting source which generates weights from a value slot.">ValuePostingSource</a>. <a href="classXapian_1_1ValuePostingSource.html#accbffc6b7f573e9a41fc234a410a1ec3">More...</a><br /></td></tr>
<tr class="separator:accbffc6b7f573e9a41fc234a410a1ec3 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa952a93fa1c80f8f8ee5b7e59b87d147 inherit pub_methods_classXapian_1_1ValuePostingSource"><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_1ValuePostingSource.html#aa952a93fa1c80f8f8ee5b7e59b87d147">get_termfreq_min</a> () const</td></tr>
<tr class="memdesc:aa952a93fa1c80f8f8ee5b7e59b87d147 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the number of documents this object can return. <a href="classXapian_1_1ValuePostingSource.html#aa952a93fa1c80f8f8ee5b7e59b87d147">More...</a><br /></td></tr>
<tr class="separator:aa952a93fa1c80f8f8ee5b7e59b87d147 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a518d58643220e417e9affda5170b1096 inherit pub_methods_classXapian_1_1ValuePostingSource"><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_1ValuePostingSource.html#a518d58643220e417e9affda5170b1096">get_termfreq_est</a> () const</td></tr>
<tr class="memdesc:a518d58643220e417e9affda5170b1096 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">An estimate of the number of documents this object can return. <a href="classXapian_1_1ValuePostingSource.html#a518d58643220e417e9affda5170b1096">More...</a><br /></td></tr>
<tr class="separator:a518d58643220e417e9affda5170b1096 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5264a143aef0e447260adc70ce225a43 inherit pub_methods_classXapian_1_1ValuePostingSource"><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_1ValuePostingSource.html#a5264a143aef0e447260adc70ce225a43">get_termfreq_max</a> () const</td></tr>
<tr class="memdesc:a5264a143aef0e447260adc70ce225a43 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the number of documents this object can return. <a href="classXapian_1_1ValuePostingSource.html#a5264a143aef0e447260adc70ce225a43">More...</a><br /></td></tr>
<tr class="separator:a5264a143aef0e447260adc70ce225a43 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a560f89bad687164dd139f9025d2bb1db inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a560f89bad687164dd139f9025d2bb1db">next</a> (double min_wt)</td></tr>
<tr class="memdesc:a560f89bad687164dd139f9025d2bb1db inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Advance the current position to the next matching document. <a href="classXapian_1_1ValuePostingSource.html#a560f89bad687164dd139f9025d2bb1db">More...</a><br /></td></tr>
<tr class="separator:a560f89bad687164dd139f9025d2bb1db inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27b5b12089a98975ad29bbcd0922556e inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a27b5b12089a98975ad29bbcd0922556e">skip_to</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> min_docid, double min_wt)</td></tr>
<tr class="memdesc:a27b5b12089a98975ad29bbcd0922556e inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Advance to the specified docid. <a href="classXapian_1_1ValuePostingSource.html#a27b5b12089a98975ad29bbcd0922556e">More...</a><br /></td></tr>
<tr class="separator:a27b5b12089a98975ad29bbcd0922556e inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab222fd63a80cb7c329b8ab4cc27405b8 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#ab222fd63a80cb7c329b8ab4cc27405b8">check</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> min_docid, double min_wt)</td></tr>
<tr class="memdesc:ab222fd63a80cb7c329b8ab4cc27405b8 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Check if the specified docid occurs. <a href="classXapian_1_1ValuePostingSource.html#ab222fd63a80cb7c329b8ab4cc27405b8">More...</a><br /></td></tr>
<tr class="separator:ab222fd63a80cb7c329b8ab4cc27405b8 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53d851ba1e75670c28c9508921273dc0 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a53d851ba1e75670c28c9508921273dc0">at_end</a> () const</td></tr>
<tr class="memdesc:a53d851ba1e75670c28c9508921273dc0 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the current position is past the last entry in this list. <a href="classXapian_1_1ValuePostingSource.html#a53d851ba1e75670c28c9508921273dc0">More...</a><br /></td></tr>
<tr class="separator:a53d851ba1e75670c28c9508921273dc0 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9a4ca847b1a444a42f76ac7b1c27752 inherit pub_methods_classXapian_1_1ValuePostingSource"><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_1ValuePostingSource.html#ad9a4ca847b1a444a42f76ac7b1c27752">get_docid</a> () const</td></tr>
<tr class="memdesc:ad9a4ca847b1a444a42f76ac7b1c27752 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Return the current docid. <a href="classXapian_1_1ValuePostingSource.html#ad9a4ca847b1a444a42f76ac7b1c27752">More...</a><br /></td></tr>
<tr class="separator:ad9a4ca847b1a444a42f76ac7b1c27752 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d4b124a53e83bfd2bcd3a5322273f57 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Xapian::Database</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a6d4b124a53e83bfd2bcd3a5322273f57">get_database</a> () const</td></tr>
<tr class="memdesc:a6d4b124a53e83bfd2bcd3a5322273f57 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">The database we're reading values from. <a href="classXapian_1_1ValuePostingSource.html#a6d4b124a53e83bfd2bcd3a5322273f57">More...</a><br /></td></tr>
<tr class="separator:a6d4b124a53e83bfd2bcd3a5322273f57 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5245e693baae3871fc289af32637f15 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#ae5245e693baae3871fc289af32637f15">get_slot</a> () const</td></tr>
<tr class="memdesc:ae5245e693baae3871fc289af32637f15 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">The slot we're reading values from. <a href="classXapian_1_1ValuePostingSource.html#ae5245e693baae3871fc289af32637f15">More...</a><br /></td></tr>
<tr class="separator:ae5245e693baae3871fc289af32637f15 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad64852538c6a36e3099ff75fe8d74ab3 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#ad64852538c6a36e3099ff75fe8d74ab3">get_value</a> () const</td></tr>
<tr class="memdesc:ad64852538c6a36e3099ff75fe8d74ab3 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Read current value. <a href="classXapian_1_1ValuePostingSource.html#ad64852538c6a36e3099ff75fe8d74ab3">More...</a><br /></td></tr>
<tr class="separator:ad64852538c6a36e3099ff75fe8d74ab3 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeae75a9b595b361b3e6c28be23048014 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#aeae75a9b595b361b3e6c28be23048014">done</a> ()</td></tr>
<tr class="memdesc:aeae75a9b595b361b3e6c28be23048014 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">End the iteration. <a href="classXapian_1_1ValuePostingSource.html#aeae75a9b595b361b3e6c28be23048014">More...</a><br /></td></tr>
<tr class="separator:aeae75a9b595b361b3e6c28be23048014 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8bb798e2c4cbc9184befb750410e7398 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a8bb798e2c4cbc9184befb750410e7398">get_started</a> () const</td></tr>
<tr class="memdesc:a8bb798e2c4cbc9184befb750410e7398 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating if we've started (true if we have). <a href="classXapian_1_1ValuePostingSource.html#a8bb798e2c4cbc9184befb750410e7398">More...</a><br /></td></tr>
<tr class="separator:a8bb798e2c4cbc9184befb750410e7398 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32e275c815ab07a5e2c2fb02da9f1928 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a32e275c815ab07a5e2c2fb02da9f1928">set_termfreq_min</a> (<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> termfreq_min_)</td></tr>
<tr class="memdesc:a32e275c815ab07a5e2c2fb02da9f1928 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Set a lower bound on the term frequency. <a href="classXapian_1_1ValuePostingSource.html#a32e275c815ab07a5e2c2fb02da9f1928">More...</a><br /></td></tr>
<tr class="separator:a32e275c815ab07a5e2c2fb02da9f1928 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7851aeed5774dbdd6b5692828730e3fc inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a7851aeed5774dbdd6b5692828730e3fc">set_termfreq_est</a> (<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> termfreq_est_)</td></tr>
<tr class="memdesc:a7851aeed5774dbdd6b5692828730e3fc inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">An estimate of the term frequency. <a href="classXapian_1_1ValuePostingSource.html#a7851aeed5774dbdd6b5692828730e3fc">More...</a><br /></td></tr>
<tr class="separator:a7851aeed5774dbdd6b5692828730e3fc inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfdc1178868ae3600c3aeb291c450b32 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#acfdc1178868ae3600c3aeb291c450b32">set_termfreq_max</a> (<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> termfreq_max_)</td></tr>
<tr class="memdesc:acfdc1178868ae3600c3aeb291c450b32 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the term frequency. <a href="classXapian_1_1ValuePostingSource.html#acfdc1178868ae3600c3aeb291c450b32">More...</a><br /></td></tr>
<tr class="separator:acfdc1178868ae3600c3aeb291c450b32 inherit pub_methods_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1PostingSource"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1PostingSource')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1PostingSource.html">Xapian::PostingSource</a></td></tr>
<tr class="memitem:a82e85d6113d9c8e72cbbf4b3362f3fd6 inherit pub_methods_classXapian_1_1PostingSource"><td class="memItemLeft" align="right" valign="top"><a id="a82e85d6113d9c8e72cbbf4b3362f3fd6"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a82e85d6113d9c8e72cbbf4b3362f3fd6">PostingSource</a> ()</td></tr>
<tr class="memdesc:a82e85d6113d9c8e72cbbf4b3362f3fd6 inherit pub_methods_classXapian_1_1PostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Allow subclasses to be instantiated. <br /></td></tr>
<tr class="separator:a82e85d6113d9c8e72cbbf4b3362f3fd6 inherit pub_methods_classXapian_1_1PostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7201a6a189625b17f501561dcc3ea8a1 inherit pub_methods_classXapian_1_1PostingSource"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a7201a6a189625b17f501561dcc3ea8a1">set_maxweight</a> (double max_weight)</td></tr>
<tr class="memdesc:a7201a6a189625b17f501561dcc3ea8a1 inherit pub_methods_classXapian_1_1PostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Specify an upper bound on what <a class="el" href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a" title="Return the weight contribution for the current document.">get_weight()</a> will return from now on. <a href="classXapian_1_1PostingSource.html#a7201a6a189625b17f501561dcc3ea8a1">More...</a><br /></td></tr>
<tr class="separator:a7201a6a189625b17f501561dcc3ea8a1 inherit pub_methods_classXapian_1_1PostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a447843283a8ef88b3d4662c97c87b4 inherit pub_methods_classXapian_1_1PostingSource"><td class="memItemLeft" align="right" valign="top"><a id="a1a447843283a8ef88b3d4662c97c87b4"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a1a447843283a8ef88b3d4662c97c87b4">get_maxweight</a> () const</td></tr>
<tr class="memdesc:a1a447843283a8ef88b3d4662c97c87b4 inherit pub_methods_classXapian_1_1PostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Return the currently set upper bound on what <a class="el" href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a" title="Return the weight contribution for the current document.">get_weight()</a> can return. <br /></td></tr>
<tr class="separator:a1a447843283a8ef88b3d4662c97c87b4 inherit pub_methods_classXapian_1_1PostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cadf2ff56f9e456e1f5a6b684cdb128 inherit pub_methods_classXapian_1_1PostingSource"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a4cadf2ff56f9e456e1f5a6b684cdb128">unserialise_with_registry</a> (const std::string &serialised, const <a class="el" href="classXapian_1_1Registry.html">Registry</a> &registry) const</td></tr>
<tr class="memdesc:a4cadf2ff56f9e456e1f5a6b684cdb128 inherit pub_methods_classXapian_1_1PostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Create object given string serialisation returned by <a class="el" href="classXapian_1_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894" title="Serialise object parameters into a string.">serialise()</a>. <a href="classXapian_1_1PostingSource.html#a4cadf2ff56f9e456e1f5a6b684cdb128">More...</a><br /></td></tr>
<tr class="separator:a4cadf2ff56f9e456e1f5a6b684cdb128 inherit pub_methods_classXapian_1_1PostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24d51135b279b59bccb37d42bc2062f1 inherit pub_methods_classXapian_1_1PostingSource"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a24d51135b279b59bccb37d42bc2062f1">release</a> ()</td></tr>
<tr class="memdesc:a24d51135b279b59bccb37d42bc2062f1 inherit pub_methods_classXapian_1_1PostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1PostingSource.html#a24d51135b279b59bccb37d42bc2062f1">More...</a><br /></td></tr>
<tr class="separator:a24d51135b279b59bccb37d42bc2062f1 inherit pub_methods_classXapian_1_1PostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15a62840bd29a630b8641722c2b8cbf8 inherit pub_methods_classXapian_1_1PostingSource"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a15a62840bd29a630b8641722c2b8cbf8">release</a> () const</td></tr>
<tr class="memdesc:a15a62840bd29a630b8641722c2b8cbf8 inherit pub_methods_classXapian_1_1PostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1PostingSource.html#a15a62840bd29a630b8641722c2b8cbf8">More...</a><br /></td></tr>
<tr class="separator:a15a62840bd29a630b8641722c2b8cbf8 inherit pub_methods_classXapian_1_1PostingSource"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classXapian_1_1ValuePostingSource"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classXapian_1_1ValuePostingSource')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classXapian_1_1ValuePostingSource.html">Xapian::ValuePostingSource</a></td></tr>
<tr class="memitem:a3bbef981fa3fac528dfee36248e55f44 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Xapian::Database</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a3bbef981fa3fac528dfee36248e55f44">db</a></td></tr>
<tr class="memdesc:a3bbef981fa3fac528dfee36248e55f44 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">The database we're reading values from. <a href="classXapian_1_1ValuePostingSource.html#a3bbef981fa3fac528dfee36248e55f44">More...</a><br /></td></tr>
<tr class="separator:a3bbef981fa3fac528dfee36248e55f44 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6102f72ea311d470d083859838bf9d8 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#ac6102f72ea311d470d083859838bf9d8">slot</a></td></tr>
<tr class="memdesc:ac6102f72ea311d470d083859838bf9d8 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">The slot we're reading values from. <a href="classXapian_1_1ValuePostingSource.html#ac6102f72ea311d470d083859838bf9d8">More...</a><br /></td></tr>
<tr class="separator:ac6102f72ea311d470d083859838bf9d8 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a650c27f6c7891bb2e0f4d96c6f743e04 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ValueIterator.html">Xapian::ValueIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#a650c27f6c7891bb2e0f4d96c6f743e04">value_it</a></td></tr>
<tr class="memdesc:a650c27f6c7891bb2e0f4d96c6f743e04 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Value stream iterator. <a href="classXapian_1_1ValuePostingSource.html#a650c27f6c7891bb2e0f4d96c6f743e04">More...</a><br /></td></tr>
<tr class="separator:a650c27f6c7891bb2e0f4d96c6f743e04 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc20089597b9ff9993526bd95d2fb653 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memItemLeft" align="right" valign="top">bool & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValuePostingSource.html#adc20089597b9ff9993526bd95d2fb653">started</a></td></tr>
<tr class="memdesc:adc20089597b9ff9993526bd95d2fb653 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">Flag indicating if we've started (true if we have). <a href="classXapian_1_1ValuePostingSource.html#adc20089597b9ff9993526bd95d2fb653">More...</a><br /></td></tr>
<tr class="separator:adc20089597b9ff9993526bd95d2fb653 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad04e70cdc505898beef5911130322746 inherit pro_attribs_classXapian_1_1ValuePostingSource"><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_1ValuePostingSource.html#ad04e70cdc505898beef5911130322746">termfreq_min</a></td></tr>
<tr class="memdesc:ad04e70cdc505898beef5911130322746 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the term frequency. <a href="classXapian_1_1ValuePostingSource.html#ad04e70cdc505898beef5911130322746">More...</a><br /></td></tr>
<tr class="separator:ad04e70cdc505898beef5911130322746 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bcadb7f9aace4bf1b577b4318451df2 inherit pro_attribs_classXapian_1_1ValuePostingSource"><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_1ValuePostingSource.html#a3bcadb7f9aace4bf1b577b4318451df2">termfreq_est</a></td></tr>
<tr class="memdesc:a3bcadb7f9aace4bf1b577b4318451df2 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">An estimate of the term frequency. <a href="classXapian_1_1ValuePostingSource.html#a3bcadb7f9aace4bf1b577b4318451df2">More...</a><br /></td></tr>
<tr class="separator:a3bcadb7f9aace4bf1b577b4318451df2 inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a897f7b589182ce1ca88ed027570b2d4e inherit pro_attribs_classXapian_1_1ValuePostingSource"><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_1ValuePostingSource.html#a897f7b589182ce1ca88ed027570b2d4e">termfreq_max</a></td></tr>
<tr class="memdesc:a897f7b589182ce1ca88ed027570b2d4e inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the term frequency. <a href="classXapian_1_1ValuePostingSource.html#a897f7b589182ce1ca88ed027570b2d4e">More...</a><br /></td></tr>
<tr class="separator:a897f7b589182ce1ca88ed027570b2d4e inherit pro_attribs_classXapian_1_1ValuePostingSource"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A posting source which looks up weights in a map using values as the key. </p>
<p>This allows will return entries for all documents in the given database which have a value in the slot specified. The values will be mapped to the corresponding weight in the weight map. If there is no mapping for a particular value, the default weight will be returned (which itself defaults to 0.0). </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aef9518eab055c5f1d3bea3fb8df4368f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef9518eab055c5f1d3bea3fb8df4368f">◆ </a></span>ValueMapPostingSource()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::ValueMapPostingSource::ValueMapPostingSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>slot_</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1ValueMapPostingSource.html" title="A posting source which looks up weights in a map using values as the key.">ValueMapPostingSource</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot_</td><td>The value slot to read values from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a126c88575ad8f06c850826ac7cd2a591"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a126c88575ad8f06c850826ac7cd2a591">◆ </a></span>add_mapping()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueMapPostingSource::add_mapping </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>wt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a mapping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key looked up from the value slot. </td></tr>
<tr><td class="paramname">wt</td><td>The weight to give this key. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a51b59d9f2126aa925a140f7fd77eef5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51b59d9f2126aa925a140f7fd77eef5e">◆ </a></span>clone()</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_1ValueMapPostingSource.html">ValueMapPostingSource</a>* Xapian::ValueMapPostingSource::clone </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone the posting source. </p>
<p>The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be in the same iteration position as the original: the matcher will always call <a class="el" href="classXapian_1_1ValueMapPostingSource.html#ae76de9cb534e96b7a0cc827d89eea8fc" title="Set this PostingSource to the start of the list of postings.">init()</a> on the clone before attempting to move the iterator, or read the information about the current position of the iterator.</p>
<p>This may return NULL to indicate that cloning is not supported. In this case, the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> may only be used with a single-database search.</p>
<p>The default implementation returns NULL.</p>
<p>Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="https://trac.xapian.org/ticket/554#comment:1">https://trac.xapian.org/ticket/554#comment:1</a> </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#ab41013bf3d3dc7d433430a69466b8582">Xapian::PostingSource</a>.</p>
</div>
</div>
<a id="ab570a48cdfe41b3c9f9203caddc7fccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab570a48cdfe41b3c9f9203caddc7fccb">◆ </a></span>get_description()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::ValueMapPostingSource::get_description </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string describing this object. </p>
<p>This default implementation returns a generic answer. This default it provided to avoid forcing those deriving their own <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclass from having to implement this (they may not care what <a class="el" href="classXapian_1_1ValueMapPostingSource.html#ab570a48cdfe41b3c9f9203caddc7fccb" title="Return a string describing this object.">get_description()</a> gives for their subclass). </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#a8a619b261e7d9db7cb7ccef9869afac8">Xapian::PostingSource</a>.</p>
</div>
</div>
<a id="a2e5ea4b5005d05933c1526d65cd3a18d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e5ea4b5005d05933c1526d65cd3a18d">◆ </a></span>get_weight()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Xapian::ValueMapPostingSource::get_weight </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the weight contribution for the current document. </p>
<p>This default implementation always returns 0, for convenience when implementing "weight-less" <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclasses.</p>
<p>This method may assume that it will only be called when there is a "current document". In detail: <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will always call <a class="el" href="classXapian_1_1ValueMapPostingSource.html#ae76de9cb534e96b7a0cc827d89eea8fc" title="Set this PostingSource to the start of the list of postings.">init()</a> on a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> before calling this for the first time. It will also only call this if the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> reports that it is pointing to a valid document (ie, it will not call it before calling at least one of <a class="el" href="classXapian_1_1ValuePostingSource.html#a560f89bad687164dd139f9025d2bb1db" title="Advance the current position to the next matching document.">next()</a>, <a class="el" href="classXapian_1_1ValuePostingSource.html#a27b5b12089a98975ad29bbcd0922556e" title="Advance to the specified docid.">skip_to()</a> or <a class="el" href="classXapian_1_1ValuePostingSource.html#ab222fd63a80cb7c329b8ab4cc27405b8" title="Check if the specified docid occurs.">check()</a>, and will ensure that the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> is not at the end by calling <a class="el" href="classXapian_1_1ValuePostingSource.html#a53d851ba1e75670c28c9508921273dc0" title="Return true if the current position is past the last entry in this list.">at_end()</a>). </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a">Xapian::PostingSource</a>.</p>
</div>
</div>
<a id="ae76de9cb534e96b7a0cc827d89eea8fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae76de9cb534e96b7a0cc827d89eea8fc">◆ </a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueMapPostingSource::init </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Database.html">Database</a> & </td>
<td class="paramname"><em>db</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set this <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> to the start of the list of postings. </p>
<p>This is called automatically by the matcher prior to each query being processed.</p>
<p>If a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> is used for multiple searches, <em><a class="el" href="classXapian_1_1ValueMapPostingSource.html#ae76de9cb534e96b7a0cc827d89eea8fc" title="Set this PostingSource to the start of the list of postings.">init()</a></em> will therefore be called multiple times, and must handle this by using the database passed in the most recent call.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">db</td><td>The database which the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> should iterate through.</td></tr>
</table>
</dd>
</dl>
<p>Note: in the case of a multi-database search, a separate <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> will be used for each database (the separate PostingSources will be obtained using <em><a class="el" href="classXapian_1_1ValueMapPostingSource.html#a51b59d9f2126aa925a140f7fd77eef5e" title="Clone the posting source.">clone()</a></em>), and each <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> will be passed one of the sub-databases as the <em>db</em> parameter here. The <em>db</em> parameter will therefore always refer to a single database. All docids passed to, or returned from, the <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> refer to docids in that single database, rather than in the multi-database. </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1ValuePostingSource.html#a764328b2a7085e24393a94eb1d2b91e0">Xapian::ValuePostingSource</a>.</p>
</div>
</div>
<a id="a3f20f584f45a63b14cd84f8ccb24b90d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f20f584f45a63b14cd84f8ccb24b90d">◆ </a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::ValueMapPostingSource::name </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the posting source class. </p>
<p>This is used when serialising and unserialising posting sources; for example, for performing remote searches.</p>
<p>If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclass called "FooPostingSource" in the "Xapian" namespace the result of this call should be "Xapian::FooPostingSource".</p>
<p>This should only be implemented if <a class="el" href="classXapian_1_1ValueMapPostingSource.html#abd71690574ee0f180a2c82c14f4715e7" title="Serialise object parameters into a string.">serialise()</a> and <a class="el" href="classXapian_1_1ValueMapPostingSource.html#af79239d7dfee4de571253fdfd3b95020" title="Create object given string serialisation returned by serialise().">unserialise()</a> are also implemented. The default implementation returns an empty string.</p>
<p>If this returns an empty string, <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will assume that <a class="el" href="classXapian_1_1ValueMapPostingSource.html#abd71690574ee0f180a2c82c14f4715e7" title="Serialise object parameters into a string.">serialise()</a> and <a class="el" href="classXapian_1_1ValueMapPostingSource.html#af79239d7dfee4de571253fdfd3b95020" title="Create object given string serialisation returned by serialise().">unserialise()</a> are not implemented. </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#a6cbbe96a7bb0d2a8c9de3d5d8b99675d">Xapian::PostingSource</a>.</p>
</div>
</div>
<a id="abd71690574ee0f180a2c82c14f4715e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd71690574ee0f180a2c82c14f4715e7">◆ </a></span>serialise()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::ValueMapPostingSource::serialise </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialise object parameters into a string. </p>
<p>The serialised parameters should represent the configuration of the posting source, but need not (indeed, should not) represent the current iteration state.</p>
<p>If you don't want to support the remote backend, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>. </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894">Xapian::PostingSource</a>.</p>
</div>
</div>
<a id="a895c2f710b42bf93f71d0321225dc38f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a895c2f710b42bf93f71d0321225dc38f">◆ </a></span>set_default_weight()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueMapPostingSource::set_default_weight </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>wt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a default weight for document values not in the map. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">wt</td><td>The weight to set as the default. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af79239d7dfee4de571253fdfd3b95020"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af79239d7dfee4de571253fdfd3b95020">◆ </a></span>unserialise()</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_1ValueMapPostingSource.html">ValueMapPostingSource</a>* Xapian::ValueMapPostingSource::unserialise </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>serialised</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create object given string serialisation returned by <a class="el" href="classXapian_1_1ValueMapPostingSource.html#abd71690574ee0f180a2c82c14f4715e7" title="Serialise object parameters into a string.">serialise()</a>. </p>
<p>Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="https://trac.xapian.org/ticket/554#comment:1">https://trac.xapian.org/ticket/554#comment:1</a></p>
<p>If you don't want to support the remote backend, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">serialised</td><td>A serialised instance of this <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> subclass. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1PostingSource.html#a6aa8602abb801a2a366a6328d36ba4a9">Xapian::PostingSource</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="postingsource_8h.html">postingsource.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>
|
