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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
|
<!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.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::PostingSource 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.22</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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_1PostingSource.html">PostingSource</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1PostingSource-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::PostingSource Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base class which provides an "external" source of postings.
<a href="classXapian_1_1PostingSource.html#details">More...</a></p>
<p><code>#include <postingsource.h></code></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::PostingSource:</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_1PostingSource__inherit__graph.png" border="0" usemap="#aXapian_1_1PostingSource_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1PostingSource_inherit__map" id="aXapian_1_1PostingSource_inherit__map">
<area shape="rect" title="Base class which provides an "external" source of postings." alt="" coords="208,42,375,69"/>
<area shape="rect" href="classXapian_1_1FixedWeightPostingSource.html" title="A posting source which returns a fixed weight for all documents." alt="" coords="423,5,626,47"/>
<area shape="rect" href="classXapian_1_1ValuePostingSource.html" title="A posting source which generates weights from a value slot." alt="" coords="423,71,627,98"/>
<area shape="rect" title=" " alt="" coords="5,35,160,76"/>
<area shape="rect" href="classXapian_1_1LatLongDistancePostingSource.html" title="Posting source which returns a weight based on geospatial distance." alt="" coords="675,5,906,47"/>
<area shape="rect" href="classXapian_1_1ValueMapPostingSource.html" title="A posting source which looks up weights in a map using values as the key." alt="" coords="675,71,907,98"/>
<area shape="rect" href="classXapian_1_1ValueWeightPostingSource.html" title="A posting source which reads weights from a value slot." alt="" coords="687,123,894,164"/>
<area shape="rect" href="classXapian_1_1DecreasingValueWeightPostingSource.html" title="Read weights from a value which is known to decrease as docid increases." alt="" coords="955,123,1185,164"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a82e85d6113d9c8e72cbbf4b3362f3fd6"><td class="memItemLeft" align="right" valign="top"><a id="a82e85d6113d9c8e72cbbf4b3362f3fd6" name="a82e85d6113d9c8e72cbbf4b3362f3fd6"></a>
 </td><td class="memItemRight" valign="bottom"><b>PostingSource</b> ()</td></tr>
<tr class="memdesc:a82e85d6113d9c8e72cbbf4b3362f3fd6"><td class="mdescLeft"> </td><td class="mdescRight">Allow subclasses to be instantiated. <br /></td></tr>
<tr class="separator:a82e85d6113d9c8e72cbbf4b3362f3fd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ecf450314e8b266eb9c8fae78e141d3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a5ecf450314e8b266eb9c8fae78e141d3">get_termfreq_min</a> () const =0</td></tr>
<tr class="memdesc:a5ecf450314e8b266eb9c8fae78e141d3"><td class="mdescLeft"> </td><td class="mdescRight">A lower bound on the number of documents this object can return. <a href="classXapian_1_1PostingSource.html#a5ecf450314e8b266eb9c8fae78e141d3">More...</a><br /></td></tr>
<tr class="separator:a5ecf450314e8b266eb9c8fae78e141d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d67eda5783f82951d6c56ad7ff4205b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a0d67eda5783f82951d6c56ad7ff4205b">get_termfreq_est</a> () const =0</td></tr>
<tr class="memdesc:a0d67eda5783f82951d6c56ad7ff4205b"><td class="mdescLeft"> </td><td class="mdescRight">An estimate of the number of documents this object can return. <a href="classXapian_1_1PostingSource.html#a0d67eda5783f82951d6c56ad7ff4205b">More...</a><br /></td></tr>
<tr class="separator:a0d67eda5783f82951d6c56ad7ff4205b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17de27c84a052c51d62ad498151a4cab"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a17de27c84a052c51d62ad498151a4cab">get_termfreq_max</a> () const =0</td></tr>
<tr class="memdesc:a17de27c84a052c51d62ad498151a4cab"><td class="mdescLeft"> </td><td class="mdescRight">An upper bound on the number of documents this object can return. <a href="classXapian_1_1PostingSource.html#a17de27c84a052c51d62ad498151a4cab">More...</a><br /></td></tr>
<tr class="separator:a17de27c84a052c51d62ad498151a4cab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7201a6a189625b17f501561dcc3ea8a1"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a447843283a8ef88b3d4662c97c87b4"><td class="memItemLeft" align="right" valign="top"><a id="a1a447843283a8ef88b3d4662c97c87b4" name="a1a447843283a8ef88b3d4662c97c87b4"></a>
double </td><td class="memItemRight" valign="bottom"><b>get_maxweight</b> () const</td></tr>
<tr class="memdesc:a1a447843283a8ef88b3d4662c97c87b4"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3922b7e3572eea6d3e39fc26cc7fed7a"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a">get_weight</a> () const</td></tr>
<tr class="memdesc:a3922b7e3572eea6d3e39fc26cc7fed7a"><td class="mdescLeft"> </td><td class="mdescRight">Return the weight contribution for the current document. <a href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a">More...</a><br /></td></tr>
<tr class="separator:a3922b7e3572eea6d3e39fc26cc7fed7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b1bd1fcd07d69204f70155588ae544a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a7b1bd1fcd07d69204f70155588ae544a">get_docid</a> () const =0</td></tr>
<tr class="memdesc:a7b1bd1fcd07d69204f70155588ae544a"><td class="mdescLeft"> </td><td class="mdescRight">Return the current docid. <a href="classXapian_1_1PostingSource.html#a7b1bd1fcd07d69204f70155588ae544a">More...</a><br /></td></tr>
<tr class="separator:a7b1bd1fcd07d69204f70155588ae544a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a150c4c07ff4e959f448dd8cf840968e8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a150c4c07ff4e959f448dd8cf840968e8">next</a> (double min_wt)=0</td></tr>
<tr class="memdesc:a150c4c07ff4e959f448dd8cf840968e8"><td class="mdescLeft"> </td><td class="mdescRight">Advance the current position to the next matching document. <a href="classXapian_1_1PostingSource.html#a150c4c07ff4e959f448dd8cf840968e8">More...</a><br /></td></tr>
<tr class="separator:a150c4c07ff4e959f448dd8cf840968e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf18a9328d8e46c3a759a3a120009607"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607">skip_to</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did, double min_wt)</td></tr>
<tr class="memdesc:acf18a9328d8e46c3a759a3a120009607"><td class="mdescLeft"> </td><td class="mdescRight">Advance to the specified docid. <a href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607">More...</a><br /></td></tr>
<tr class="separator:acf18a9328d8e46c3a759a3a120009607"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a964696f90b6485bf3c931ccf4546a273"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a964696f90b6485bf3c931ccf4546a273">check</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did, double min_wt)</td></tr>
<tr class="memdesc:a964696f90b6485bf3c931ccf4546a273"><td class="mdescLeft"> </td><td class="mdescRight">Check if the specified docid occurs. <a href="classXapian_1_1PostingSource.html#a964696f90b6485bf3c931ccf4546a273">More...</a><br /></td></tr>
<tr class="separator:a964696f90b6485bf3c931ccf4546a273"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98831c9fdea1599f588cd9fef51bbeb5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a98831c9fdea1599f588cd9fef51bbeb5">at_end</a> () const =0</td></tr>
<tr class="memdesc:a98831c9fdea1599f588cd9fef51bbeb5"><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_1PostingSource.html#a98831c9fdea1599f588cd9fef51bbeb5">More...</a><br /></td></tr>
<tr class="separator:a98831c9fdea1599f588cd9fef51bbeb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cf13187b0d403b63888dd532bbfe7f6"><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#a5cf13187b0d403b63888dd532bbfe7f6">clone</a> () const</td></tr>
<tr class="memdesc:a5cf13187b0d403b63888dd532bbfe7f6"><td class="mdescLeft"> </td><td class="mdescRight">Clone the posting source. <a href="classXapian_1_1PostingSource.html#a5cf13187b0d403b63888dd532bbfe7f6">More...</a><br /></td></tr>
<tr class="separator:a5cf13187b0d403b63888dd532bbfe7f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cbbe96a7bb0d2a8c9de3d5d8b99675d"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a6cbbe96a7bb0d2a8c9de3d5d8b99675d">name</a> () const</td></tr>
<tr class="memdesc:a6cbbe96a7bb0d2a8c9de3d5d8b99675d"><td class="mdescLeft"> </td><td class="mdescRight">Name of the posting source class. <a href="classXapian_1_1PostingSource.html#a6cbbe96a7bb0d2a8c9de3d5d8b99675d">More...</a><br /></td></tr>
<tr class="separator:a6cbbe96a7bb0d2a8c9de3d5d8b99675d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ad6b98d6b5e79a37b7a1d7874725894"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894">serialise</a> () const</td></tr>
<tr class="memdesc:a0ad6b98d6b5e79a37b7a1d7874725894"><td class="mdescLeft"> </td><td class="mdescRight">Serialise object parameters into a string. <a href="classXapian_1_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894">More...</a><br /></td></tr>
<tr class="separator:a0ad6b98d6b5e79a37b7a1d7874725894"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf7161bbfff95fedf27640342672adc6"><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#adf7161bbfff95fedf27640342672adc6">unserialise</a> (const std::string &serialised) const</td></tr>
<tr class="memdesc:adf7161bbfff95fedf27640342672adc6"><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#adf7161bbfff95fedf27640342672adc6">More...</a><br /></td></tr>
<tr class="separator:adf7161bbfff95fedf27640342672adc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7bd73f7f8d6c07a732600a7ddf59060"><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#ae7bd73f7f8d6c07a732600a7ddf59060">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:ae7bd73f7f8d6c07a732600a7ddf59060"><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#ae7bd73f7f8d6c07a732600a7ddf59060">More...</a><br /></td></tr>
<tr class="separator:ae7bd73f7f8d6c07a732600a7ddf59060"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81d793170b496022488c15c3508979b5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a81d793170b496022488c15c3508979b5">init</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &db)=0</td></tr>
<tr class="memdesc:a81d793170b496022488c15c3508979b5"><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_1PostingSource.html#a81d793170b496022488c15c3508979b5">More...</a><br /></td></tr>
<tr class="separator:a81d793170b496022488c15c3508979b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a619b261e7d9db7cb7ccef9869afac8"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PostingSource.html#a8a619b261e7d9db7cb7ccef9869afac8">get_description</a> () const</td></tr>
<tr class="memdesc:a8a619b261e7d9db7cb7ccef9869afac8"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="classXapian_1_1PostingSource.html#a8a619b261e7d9db7cb7ccef9869afac8">More...</a><br /></td></tr>
<tr class="separator:a8a619b261e7d9db7cb7ccef9869afac8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60fc251bd7c2f46536256f6b9898caf3"><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#a60fc251bd7c2f46536256f6b9898caf3">release</a> ()</td></tr>
<tr class="memdesc:a60fc251bd7c2f46536256f6b9898caf3"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1PostingSource.html#a60fc251bd7c2f46536256f6b9898caf3">More...</a><br /></td></tr>
<tr class="separator:a60fc251bd7c2f46536256f6b9898caf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa99a103682c892018a1452f88c31664a"><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#aa99a103682c892018a1452f88c31664a">release</a> () const</td></tr>
<tr class="memdesc:aa99a103682c892018a1452f88c31664a"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1PostingSource.html#aa99a103682c892018a1452f88c31664a">More...</a><br /></td></tr>
<tr class="separator:aa99a103682c892018a1452f88c31664a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Base class which provides an "external" source of postings. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a98831c9fdea1599f588cd9fef51bbeb5" name="a98831c9fdea1599f588cd9fef51bbeb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98831c9fdea1599f588cd9fef51bbeb5">◆ </a></span>at_end()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Xapian::PostingSource::at_end </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the current position is past the last entry in this list. </p>
<p >At least one of <em><a class="el" href="classXapian_1_1PostingSource.html#a150c4c07ff4e959f448dd8cf840968e8" title="Advance the current position to the next matching document.">next()</a></em>, <em><a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a></em> or <em><a class="el" href="classXapian_1_1PostingSource.html#a964696f90b6485bf3c931ccf4546a273" title="Check if the specified docid occurs.">check()</a></em> will be called before this method is first called. </p>
<p>Implemented in <a class="el" href="classXapian_1_1ValuePostingSource.html#a53d851ba1e75670c28c9508921273dc0">Xapian::ValuePostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a1902a25f0ca56bfd772225efdce0303b">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a964696f90b6485bf3c931ccf4546a273" name="a964696f90b6485bf3c931ccf4546a273"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a964696f90b6485bf3c931ccf4546a273">◆ </a></span>check()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Xapian::PostingSource::check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td>
<td class="paramname"><em>did</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>min_wt</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Check if the specified docid occurs. </p>
<p >The caller is required to ensure that the specified document id <em>did</em> actually exists in the database. If it does, it must move to that document id, and return true. If it does not, it may either:</p>
<ul>
<li>return true, having moved to a definite position (including "at_end"), which must be the same position as <a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a> would have moved to.</li>
</ul>
<p >or</p>
<ul>
<li>return false, having moved to an "indeterminate" position, such that a subsequent call to <a class="el" href="classXapian_1_1PostingSource.html#a150c4c07ff4e959f448dd8cf840968e8" title="Advance the current position to the next matching document.">next()</a> or <a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a> will move to the next matching position after <em>did</em>.</li>
</ul>
<p >Generally, this method should act like <a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a> and return true if that can be done at little extra cost.</p>
<p >Otherwise it should simply check if a particular docid is present, returning true if it is, and false if it isn't.</p>
<p >The default implementation calls <a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a> and always returns true.</p>
<p ><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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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.</p>
<p >Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the <em><a class="el" href="classXapian_1_1PostingSource.html#a81d793170b496022488c15c3508979b5" title="Set this PostingSource to the start of the list of postings.">init()</a></em> method for details.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">did</td><td>The document id to check. </td></tr>
<tr><td class="paramname">min_wt</td><td>The minimum weight contribution that is needed (this is just a hint which subclasses may ignore). </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a89b0848c6423fa83ed22f43652e79077">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValuePostingSource.html#ab222fd63a80cb7c329b8ab4cc27405b8">Xapian::ValuePostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#a7e4738f89c9ff109acd8a6d6ed0e71c0">Xapian::DecreasingValueWeightPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#acd408e3a5cb1cdd02b0fa382b1afb9aa">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a5cf13187b0d403b63888dd532bbfe7f6" name="a5cf13187b0d403b63888dd532bbfe7f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cf13187b0d403b63888dd532bbfe7f6">◆ </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">virtual <a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * Xapian::PostingSource::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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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 in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a1d05a87e0672376a1cbd160c26f341a9">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValueWeightPostingSource.html#a9859b27521a1d9737b0b75f67e39e977">Xapian::ValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#ae3e1098daef8591370b1f542e242b6f4">Xapian::DecreasingValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1ValueMapPostingSource.html#a26772d37ae4a233a95d6eeffb12ef16e">Xapian::ValueMapPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a22404fd186e3b241db898b538cbd73aa">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a8a619b261e7d9db7cb7ccef9869afac8" name="a8a619b261e7d9db7cb7ccef9869afac8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a619b261e7d9db7cb7ccef9869afac8">◆ </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">virtual std::string Xapian::PostingSource::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_1PostingSource.html#a8a619b261e7d9db7cb7ccef9869afac8" title="Return a string describing this object.">get_description()</a> gives for their subclass). </p>
<p>Reimplemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a6f7e0a9442cd671295abbb69f5c4ad13">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValueWeightPostingSource.html#abc1e8423faf4265d386411fed6554e4c">Xapian::ValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#adbe8b45ca7014f52376301905dc905d4">Xapian::DecreasingValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1ValueMapPostingSource.html#ab570a48cdfe41b3c9f9203caddc7fccb">Xapian::ValueMapPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a89edb2843e09624e63d06246ec21d768">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a7b1bd1fcd07d69204f70155588ae544a" name="a7b1bd1fcd07d69204f70155588ae544a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b1bd1fcd07d69204f70155588ae544a">◆ </a></span>get_docid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> Xapian::PostingSource::get_docid </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current docid. </p>
<p >This method may assume that it will only be called when there is a "current document". See <em><a class="el" href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a" title="Return the weight contribution for the current document.">get_weight()</a></em> for details.</p>
<p >Note: in the case of a multi-database search, the returned docid should be in the single subdatabase relevant to this posting source. See the <em><a class="el" href="classXapian_1_1PostingSource.html#a81d793170b496022488c15c3508979b5" title="Set this PostingSource to the start of the list of postings.">init()</a></em> method for details. </p>
<p>Implemented in <a class="el" href="classXapian_1_1ValuePostingSource.html#ad9a4ca847b1a444a42f76ac7b1c27752">Xapian::ValuePostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a8491b5d1bf7557b7b2e3de30cab07acf">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a0d67eda5783f82951d6c56ad7ff4205b" name="a0d67eda5783f82951d6c56ad7ff4205b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d67eda5783f82951d6c56ad7ff4205b">◆ </a></span>get_termfreq_est()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> Xapian::PostingSource::get_termfreq_est </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An estimate of the number of documents this object can return. </p>
<p >It must always be true that:</p>
<p ><a class="el" href="classXapian_1_1PostingSource.html#a5ecf450314e8b266eb9c8fae78e141d3" title="A lower bound on the number of documents this object can return.">get_termfreq_min()</a> <= <a class="el" href="classXapian_1_1PostingSource.html#a0d67eda5783f82951d6c56ad7ff4205b" title="An estimate of the number of documents this object can return.">get_termfreq_est()</a> <= <a class="el" href="classXapian_1_1PostingSource.html#a17de27c84a052c51d62ad498151a4cab" title="An upper bound on the number of documents this object can return.">get_termfreq_max()</a></p>
<p ><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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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. </p>
<p>Implemented in <a class="el" href="classXapian_1_1ValuePostingSource.html#a518d58643220e417e9affda5170b1096">Xapian::ValuePostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#ab30ce9ad09792a948bbb3b6670d73525">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a17de27c84a052c51d62ad498151a4cab" name="a17de27c84a052c51d62ad498151a4cab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17de27c84a052c51d62ad498151a4cab">◆ </a></span>get_termfreq_max()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> Xapian::PostingSource::get_termfreq_max </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An upper bound on the number of documents this object can return. </p>
<p ><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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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. </p>
<p>Implemented in <a class="el" href="classXapian_1_1ValuePostingSource.html#a5264a143aef0e447260adc70ce225a43">Xapian::ValuePostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a10ccfe06a7c5cf60bd9118b938d753f8">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a5ecf450314e8b266eb9c8fae78e141d3" name="a5ecf450314e8b266eb9c8fae78e141d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ecf450314e8b266eb9c8fae78e141d3">◆ </a></span>get_termfreq_min()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> Xapian::PostingSource::get_termfreq_min </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A lower bound on the number of documents this object can return. </p>
<p ><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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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. </p>
<p>Implemented in <a class="el" href="classXapian_1_1ValuePostingSource.html#aa952a93fa1c80f8f8ee5b7e59b87d147">Xapian::ValuePostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#ae22eeb74290e601e58efcb1f89c5e446">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a3922b7e3572eea6d3e39fc26cc7fed7a" name="a3922b7e3572eea6d3e39fc26cc7fed7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3922b7e3572eea6d3e39fc26cc7fed7a">◆ </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">virtual double Xapian::PostingSource::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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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_1PostingSource.html#a150c4c07ff4e959f448dd8cf840968e8" title="Advance the current position to the next matching document.">next()</a>, <a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a> or <a class="el" href="classXapian_1_1PostingSource.html#a964696f90b6485bf3c931ccf4546a273" 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_1PostingSource.html#a98831c9fdea1599f588cd9fef51bbeb5" title="Return true if the current position is past the last entry in this list.">at_end()</a>). </p>
<p>Reimplemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a7fecce9dea6df827943c379caa2d0cd2">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValueWeightPostingSource.html#a9407ffa6cc198b00f878666f10684e5d">Xapian::ValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#ac8f62fa21790a4060a5066e383295bce">Xapian::DecreasingValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1ValueMapPostingSource.html#a2e5ea4b5005d05933c1526d65cd3a18d">Xapian::ValueMapPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a74d1255de88916bf823b902c5da77f66">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a81d793170b496022488c15c3508979b5" name="a81d793170b496022488c15c3508979b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81d793170b496022488c15c3508979b5">◆ </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">virtual void Xapian::PostingSource::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">pure 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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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_1PostingSource.html#a5cf13187b0d403b63888dd532bbfe7f6" 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>Implemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#ac3bb27d2891a9f3a8a2ceee0eaa0e747">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValuePostingSource.html#a764328b2a7085e24393a94eb1d2b91e0">Xapian::ValuePostingSource</a>, <a class="el" href="classXapian_1_1ValueWeightPostingSource.html#ac3844351e28448d1de38fe089d626db4">Xapian::ValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1ValueMapPostingSource.html#ae76de9cb534e96b7a0cc827d89eea8fc">Xapian::ValueMapPostingSource</a>, <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a3c9698d1d0d4d47247bd19451e1e2077">Xapian::FixedWeightPostingSource</a>, and <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#aabbd9d95d77e2aa947377c44d1bb733c">Xapian::DecreasingValueWeightPostingSource</a>.</p>
</div>
</div>
<a id="a6cbbe96a7bb0d2a8c9de3d5d8b99675d" name="a6cbbe96a7bb0d2a8c9de3d5d8b99675d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cbbe96a7bb0d2a8c9de3d5d8b99675d">◆ </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">virtual std::string Xapian::PostingSource::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_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894" title="Serialise object parameters into a string.">serialise()</a> and <a class="el" href="classXapian_1_1PostingSource.html#adf7161bbfff95fedf27640342672adc6" 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_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894" title="Serialise object parameters into a string.">serialise()</a> and <a class="el" href="classXapian_1_1PostingSource.html#adf7161bbfff95fedf27640342672adc6" title="Create object given string serialisation returned by serialise().">unserialise()</a> are not implemented. </p>
<p>Reimplemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a4ad81327348feeb9b68c3e37d26f45c7">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValueWeightPostingSource.html#a5efd7ac359a8eed2472c8c62f1492567">Xapian::ValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#a40a52db2d7e94688cfb44cc142d83ef2">Xapian::DecreasingValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1ValueMapPostingSource.html#a3f20f584f45a63b14cd84f8ccb24b90d">Xapian::ValueMapPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a1941bb382b3260bdf188151339ebb26b">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a150c4c07ff4e959f448dd8cf840968e8" name="a150c4c07ff4e959f448dd8cf840968e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a150c4c07ff4e959f448dd8cf840968e8">◆ </a></span>next()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Xapian::PostingSource::next </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>min_wt</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the current position to the next matching document. </p>
<p >The <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> starts before the first entry in the list, so <a class="el" href="classXapian_1_1PostingSource.html#a150c4c07ff4e959f448dd8cf840968e8" title="Advance the current position to the next matching document.">next()</a>, <a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a> or <a class="el" href="classXapian_1_1PostingSource.html#a964696f90b6485bf3c931ccf4546a273" title="Check if the specified docid occurs.">check()</a> must be called before any methods which need the context of the current position.</p>
<p ><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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min_wt</td><td>The minimum weight contribution that is needed (this is just a hint which subclasses may ignore). </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a563dd69bf4113b73aa12335c3e282ae5">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValuePostingSource.html#a560f89bad687164dd139f9025d2bb1db">Xapian::ValuePostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#a6b4a3f76964292eb8a04d20059852f3b">Xapian::DecreasingValueWeightPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a5387052adf96613d7528862ef5ffd3ce">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a60fc251bd7c2f46536256f6b9898caf3" name="a60fc251bd7c2f46536256f6b9898caf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60fc251bd7c2f46536256f6b9898caf3">◆ </a></span>release() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * Xapian::PostingSource::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start reference counting this object. </p>
<p >You can hand ownership of a dynamically allocated <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> object to <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> by calling <a class="el" href="classXapian_1_1PostingSource.html#a60fc251bd7c2f46536256f6b9898caf3" title="Start reference counting this object.">release()</a> and then passing the object to a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> method. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will arrange to delete the object once it is no longer required. </p>
</div>
</div>
<a id="aa99a103682c892018a1452f88c31664a" name="aa99a103682c892018a1452f88c31664a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa99a103682c892018a1452f88c31664a">◆ </a></span>release() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * Xapian::PostingSource::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start reference counting this object. </p>
<p >You can hand ownership of a dynamically allocated <a class="el" href="classXapian_1_1PostingSource.html" title="Base class which provides an "external" source of postings.">PostingSource</a> object to <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> by calling <a class="el" href="classXapian_1_1PostingSource.html#a60fc251bd7c2f46536256f6b9898caf3" title="Start reference counting this object.">release()</a> and then passing the object to a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> method. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will arrange to delete the object once it is no longer required. </p>
</div>
</div>
<a id="a0ad6b98d6b5e79a37b7a1d7874725894" name="a0ad6b98d6b5e79a37b7a1d7874725894"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ad6b98d6b5e79a37b7a1d7874725894">◆ </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">virtual std::string Xapian::PostingSource::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 in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a7c3687449188ea137dec58065906fc0f">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValueWeightPostingSource.html#aa060e8297dda2aa1c70303edee8614ef">Xapian::ValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#ab5cb67129ae140ccc63428a483110cbd">Xapian::DecreasingValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1ValueMapPostingSource.html#abd71690574ee0f180a2c82c14f4715e7">Xapian::ValueMapPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a3341be21837bf85c2061a5fa9fe682c2">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="a7201a6a189625b17f501561dcc3ea8a1" name="a7201a6a189625b17f501561dcc3ea8a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7201a6a189625b17f501561dcc3ea8a1">◆ </a></span>set_maxweight()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::PostingSource::set_maxweight </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>max_weight</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
<p >This upper bound is used by the matcher to perform various optimisations, so if you can return a good bound, then matches will generally run faster.</p>
<p >This method should be called after calling <a class="el" href="classXapian_1_1PostingSource.html#a81d793170b496022488c15c3508979b5" title="Set this PostingSource to the start of the list of postings.">init()</a>, and may be called during iteration if the upper bound drops. It is probably only useful to call from subclasses (it was actually a "protected" method prior to <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> 1.3.4, but that makes it tricky to wrap for other languages).</p>
<p >It is valid for the posting source to have returned a higher value from <a class="el" href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a" title="Return the weight contribution for the current document.">get_weight()</a> earlier in the iteration, but the posting source must not return a higher value from <a class="el" href="classXapian_1_1PostingSource.html#a3922b7e3572eea6d3e39fc26cc7fed7a" title="Return the weight contribution for the current document.">get_weight()</a> than the currently set upper bound, and the upper bound must not be increased (until <a class="el" href="classXapian_1_1PostingSource.html#a81d793170b496022488c15c3508979b5" title="Set this PostingSource to the start of the list of postings.">init()</a> has been called).</p>
<p >If you don't call this method, the upper bound will default to 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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">max_weight</td><td>The upper bound to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acf18a9328d8e46c3a759a3a120009607" name="acf18a9328d8e46c3a759a3a120009607"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf18a9328d8e46c3a759a3a120009607">◆ </a></span>skip_to()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Xapian::PostingSource::skip_to </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td>
<td class="paramname"><em>did</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>min_wt</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Advance to the specified docid. </p>
<p >If the specified docid isn't in the list, position ourselves on the first document after it (or <a class="el" href="classXapian_1_1PostingSource.html#a98831c9fdea1599f588cd9fef51bbeb5" title="Return true if the current position is past the last entry in this list.">at_end()</a> if no greater docids are present).</p>
<p >If the current position is already the specified docid, this method will leave the position unmodified.</p>
<p >If the specified docid is earlier than the current position, the behaviour is unspecified. A sensible behaviour would be to leave the current position unmodified, but it is also reasonable to move to the specified docid.</p>
<p >The default implementation calls <a class="el" href="classXapian_1_1PostingSource.html#a150c4c07ff4e959f448dd8cf840968e8" title="Advance the current position to the next matching document.">next()</a> repeatedly, which works but <a class="el" href="classXapian_1_1PostingSource.html#acf18a9328d8e46c3a759a3a120009607" title="Advance to the specified docid.">skip_to()</a> can often be implemented much more efficiently.</p>
<p ><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_1PostingSource.html#a81d793170b496022488c15c3508979b5" 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.</p>
<p >Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the <em><a class="el" href="classXapian_1_1PostingSource.html#a81d793170b496022488c15c3508979b5" title="Set this PostingSource to the start of the list of postings.">init()</a></em> method for details.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">did</td><td>The document id to advance to. </td></tr>
<tr><td class="paramname">min_wt</td><td>The minimum weight contribution that is needed (this is just a hint which subclasses may ignore). </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#a85e5437efbd9b9e016bc3cd12b41b0db">Xapian::LatLongDistancePostingSource</a>, <a class="el" href="classXapian_1_1ValuePostingSource.html#a27b5b12089a98975ad29bbcd0922556e">Xapian::ValuePostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#aa70bb8128fa24aa8940bb518c9c01905">Xapian::DecreasingValueWeightPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#a90fc7e7c584e400f2eb1442ac02dfba4">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="adf7161bbfff95fedf27640342672adc6" name="adf7161bbfff95fedf27640342672adc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf7161bbfff95fedf27640342672adc6">◆ </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">virtual <a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * Xapian::PostingSource::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_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894" 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 in <a class="el" href="classXapian_1_1ValueWeightPostingSource.html#aef62a8900edb808209867b95fe67daec">Xapian::ValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1DecreasingValueWeightPostingSource.html#a6d985f5ae6d81d433f5940527625ed70">Xapian::DecreasingValueWeightPostingSource</a>, <a class="el" href="classXapian_1_1ValueMapPostingSource.html#a08d30351ffa29a17f766b78f2882498a">Xapian::ValueMapPostingSource</a>, and <a class="el" href="classXapian_1_1FixedWeightPostingSource.html#ab3863bfc8630317aa96c8422a2fb4d5d">Xapian::FixedWeightPostingSource</a>.</p>
</div>
</div>
<a id="ae7bd73f7f8d6c07a732600a7ddf59060" name="ae7bd73f7f8d6c07a732600a7ddf59060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7bd73f7f8d6c07a732600a7ddf59060">◆ </a></span>unserialise_with_registry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXapian_1_1PostingSource.html">PostingSource</a> * Xapian::PostingSource::unserialise_with_registry </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>serialised</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Registry.html">Registry</a> & </td>
<td class="paramname"><em>registry</em> </td>
</tr>
<tr>
<td></td>
<td>)</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_1PostingSource.html#a0ad6b98d6b5e79a37b7a1d7874725894" 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 >This method is supplied with a <a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> object, which can be used when unserialising objects contained within the posting source. The default implementation simply calls <a class="el" href="classXapian_1_1PostingSource.html#adf7161bbfff95fedf27640342672adc6" title="Create object given string serialisation returned by serialise().">unserialise()</a> which doesn't take the <a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> object, so you do not need to implement this method unless you want to take advantage of the <a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> object when unserialising.</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>
<tr><td class="paramname">registry</td><td>The <a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Xapian::Registry</a> object to use. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classXapian_1_1LatLongDistancePostingSource.html#aa2f9978d2f71b3d5cadf395344dde790">Xapian::LatLongDistancePostingSource</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.4</a>
</small></address>
</body>
</html>
|
