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
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
|
<!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::Enquire 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_1Enquire.html">Enquire</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="classXapian_1_1Enquire-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::Enquire Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class provides an interface to the information retrieval system for the purpose of searching.
<a href="classXapian_1_1Enquire.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad87c8d66b4646c6a9b19f4e88fb4296b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296b">docid_order</a> { <a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296ba5a930d75a962b5d9c08f59920db4aa8a">ASCENDING</a> = 1
, <a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296ba0cf8b75c1fcd0ab6dbc3af0635a0b104">DESCENDING</a> = 0
, <a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296baccadd30465837795cd7cf9b679df162e">DONT_CARE</a> = 2
}</td></tr>
<tr class="memdesc:ad87c8d66b4646c6a9b19f4e88fb4296b"><td class="mdescLeft"> </td><td class="mdescRight">Ordering of docids. <a href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296b">More...</a><br /></td></tr>
<tr class="separator:ad87c8d66b4646c6a9b19f4e88fb4296b"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:ac451dc68045ec4b0d26f5b2a42eae2a9"><td class="memItemLeft" align="right" valign="top"><a id="ac451dc68045ec4b0d26f5b2a42eae2a9"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#ac451dc68045ec4b0d26f5b2a42eae2a9">Enquire</a> (const <a class="el" href="classXapian_1_1Enquire.html">Enquire</a> &other)</td></tr>
<tr class="memdesc:ac451dc68045ec4b0d26f5b2a42eae2a9"><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed (and is cheap). <br /></td></tr>
<tr class="separator:ac451dc68045ec4b0d26f5b2a42eae2a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c067ef5b6397ab064d09884efc06cbe"><td class="memItemLeft" align="right" valign="top"><a id="a0c067ef5b6397ab064d09884efc06cbe"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a0c067ef5b6397ab064d09884efc06cbe">operator=</a> (const <a class="el" href="classXapian_1_1Enquire.html">Enquire</a> &other)</td></tr>
<tr class="memdesc:a0c067ef5b6397ab064d09884efc06cbe"><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed (and is cheap). <br /></td></tr>
<tr class="separator:a0c067ef5b6397ab064d09884efc06cbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a5197e96345339874b2138264320256"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a5a5197e96345339874b2138264320256">Enquire</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &database)</td></tr>
<tr class="memdesc:a5a5197e96345339874b2138264320256"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object. <a href="classXapian_1_1Enquire.html#a5a5197e96345339874b2138264320256">More...</a><br /></td></tr>
<tr class="separator:a5a5197e96345339874b2138264320256"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35053eb5e4b367d8f1bb763e03b3c99b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a35053eb5e4b367d8f1bb763e03b3c99b">Enquire</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &database, <a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a> *errorhandler_)</td></tr>
<tr class="memdesc:a35053eb5e4b367d8f1bb763e03b3c99b"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object. <a href="classXapian_1_1Enquire.html#a35053eb5e4b367d8f1bb763e03b3c99b">More...</a><br /></td></tr>
<tr class="separator:a35053eb5e4b367d8f1bb763e03b3c99b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a808479faae76453f34a24881805e75b9"><td class="memItemLeft" align="right" valign="top"><a id="a808479faae76453f34a24881805e75b9"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a808479faae76453f34a24881805e75b9">~Enquire</a> ()</td></tr>
<tr class="memdesc:a808479faae76453f34a24881805e75b9"><td class="mdescLeft"> </td><td class="mdescRight">Close the <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object. <br /></td></tr>
<tr class="separator:a808479faae76453f34a24881805e75b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1148d960120662e5543e2a2b12620318"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a1148d960120662e5543e2a2b12620318">set_query</a> (const <a class="el" href="classXapian_1_1Query.html">Xapian::Query</a> &query, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> qlen=0)</td></tr>
<tr class="memdesc:a1148d960120662e5543e2a2b12620318"><td class="mdescLeft"> </td><td class="mdescRight">Set the query to run. <a href="classXapian_1_1Enquire.html#a1148d960120662e5543e2a2b12620318">More...</a><br /></td></tr>
<tr class="separator:a1148d960120662e5543e2a2b12620318"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f27e1e333d6698e597b1d754c686ebf"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1Query.html">Xapian::Query</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a6f27e1e333d6698e597b1d754c686ebf">get_query</a> () const</td></tr>
<tr class="memdesc:a6f27e1e333d6698e597b1d754c686ebf"><td class="mdescLeft"> </td><td class="mdescRight">Get the current query. <a href="classXapian_1_1Enquire.html#a6f27e1e333d6698e597b1d754c686ebf">More...</a><br /></td></tr>
<tr class="separator:a6f27e1e333d6698e597b1d754c686ebf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43b54489c53d26a98d3fde3f1d3aa14f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a43b54489c53d26a98d3fde3f1d3aa14f">add_matchspy</a> (<a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> *spy)</td></tr>
<tr class="memdesc:a43b54489c53d26a98d3fde3f1d3aa14f"><td class="mdescLeft"> </td><td class="mdescRight">Add a matchspy. <a href="classXapian_1_1Enquire.html#a43b54489c53d26a98d3fde3f1d3aa14f">More...</a><br /></td></tr>
<tr class="separator:a43b54489c53d26a98d3fde3f1d3aa14f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bb73406e3e7749a9e66ebc96ebd13f3"><td class="memItemLeft" align="right" valign="top"><a id="a1bb73406e3e7749a9e66ebc96ebd13f3"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a1bb73406e3e7749a9e66ebc96ebd13f3">clear_matchspies</a> ()</td></tr>
<tr class="memdesc:a1bb73406e3e7749a9e66ebc96ebd13f3"><td class="mdescLeft"> </td><td class="mdescRight">Remove all the matchspies. <br /></td></tr>
<tr class="separator:a1bb73406e3e7749a9e66ebc96ebd13f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5c72e6f34c5c2da5f0b8c79736704ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#ad5c72e6f34c5c2da5f0b8c79736704ab">set_weighting_scheme</a> (const <a class="el" href="classXapian_1_1Weight.html">Weight</a> &weight_)</td></tr>
<tr class="memdesc:ad5c72e6f34c5c2da5f0b8c79736704ab"><td class="mdescLeft"> </td><td class="mdescRight">Set the weighting scheme to use for queries. <a href="classXapian_1_1Enquire.html#ad5c72e6f34c5c2da5f0b8c79736704ab">More...</a><br /></td></tr>
<tr class="separator:ad5c72e6f34c5c2da5f0b8c79736704ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a002147c94aff96d5d0cb394f018b6363"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a002147c94aff96d5d0cb394f018b6363">set_expansion_scheme</a> (const std::string &eweightname_, double expand_k_=1.0) const</td></tr>
<tr class="memdesc:a002147c94aff96d5d0cb394f018b6363"><td class="mdescLeft"> </td><td class="mdescRight">Set the weighting scheme to use for expansion. <a href="classXapian_1_1Enquire.html#a002147c94aff96d5d0cb394f018b6363">More...</a><br /></td></tr>
<tr class="separator:a002147c94aff96d5d0cb394f018b6363"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a117ee547f5908e952e2e72d5a986d3bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a117ee547f5908e952e2e72d5a986d3bb">set_collapse_key</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> collapse_key, <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> collapse_max=1)</td></tr>
<tr class="memdesc:a117ee547f5908e952e2e72d5a986d3bb"><td class="mdescLeft"> </td><td class="mdescRight">Set the collapse key to use for queries. <a href="classXapian_1_1Enquire.html#a117ee547f5908e952e2e72d5a986d3bb">More...</a><br /></td></tr>
<tr class="separator:a117ee547f5908e952e2e72d5a986d3bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbf7ff734ff6adcb301e493f6eed803b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#abbf7ff734ff6adcb301e493f6eed803b">set_docid_order</a> (<a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296b">docid_order</a> order)</td></tr>
<tr class="memdesc:abbf7ff734ff6adcb301e493f6eed803b"><td class="mdescLeft"> </td><td class="mdescRight">Set sort order for document IDs. <a href="classXapian_1_1Enquire.html#abbf7ff734ff6adcb301e493f6eed803b">More...</a><br /></td></tr>
<tr class="separator:abbf7ff734ff6adcb301e493f6eed803b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70bc7137850fe46d98e62c1020539d22"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a70bc7137850fe46d98e62c1020539d22">set_cutoff</a> (int percent_cutoff, double weight_cutoff=0)</td></tr>
<tr class="memdesc:a70bc7137850fe46d98e62c1020539d22"><td class="mdescLeft"> </td><td class="mdescRight">Set the percentage and/or weight cutoffs. <a href="classXapian_1_1Enquire.html#a70bc7137850fe46d98e62c1020539d22">More...</a><br /></td></tr>
<tr class="separator:a70bc7137850fe46d98e62c1020539d22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80a33a28791c05167204706c1a9d986b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a80a33a28791c05167204706c1a9d986b">set_sort_by_relevance</a> ()</td></tr>
<tr class="memdesc:a80a33a28791c05167204706c1a9d986b"><td class="mdescLeft"> </td><td class="mdescRight">Set the sorting to be by relevance only. <a href="classXapian_1_1Enquire.html#a80a33a28791c05167204706c1a9d986b">More...</a><br /></td></tr>
<tr class="separator:a80a33a28791c05167204706c1a9d986b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab10384fabd51eebd8174f916563e3f7a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#ab10384fabd51eebd8174f916563e3f7a">set_sort_by_value</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> sort_key, bool reverse)</td></tr>
<tr class="memdesc:ab10384fabd51eebd8174f916563e3f7a"><td class="mdescLeft"> </td><td class="mdescRight">Set the sorting to be by value only. <a href="classXapian_1_1Enquire.html#ab10384fabd51eebd8174f916563e3f7a">More...</a><br /></td></tr>
<tr class="separator:ab10384fabd51eebd8174f916563e3f7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bcb7086d8633fc035c6e5d094e45d39"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a0bcb7086d8633fc035c6e5d094e45d39">set_sort_by_key</a> (<a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a> *sorter, bool reverse)</td></tr>
<tr class="memdesc:a0bcb7086d8633fc035c6e5d094e45d39"><td class="mdescLeft"> </td><td class="mdescRight">Set the sorting to be by key generated from values only. <a href="classXapian_1_1Enquire.html#a0bcb7086d8633fc035c6e5d094e45d39">More...</a><br /></td></tr>
<tr class="separator:a0bcb7086d8633fc035c6e5d094e45d39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa921b3c9386fbe2ddfd7dbbf130f9391"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#aa921b3c9386fbe2ddfd7dbbf130f9391">set_sort_by_value_then_relevance</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> sort_key, bool reverse)</td></tr>
<tr class="memdesc:aa921b3c9386fbe2ddfd7dbbf130f9391"><td class="mdescLeft"> </td><td class="mdescRight">Set the sorting to be by value, then by relevance for documents with the same value. <a href="classXapian_1_1Enquire.html#aa921b3c9386fbe2ddfd7dbbf130f9391">More...</a><br /></td></tr>
<tr class="separator:aa921b3c9386fbe2ddfd7dbbf130f9391"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a562beac4843f310dbdc61fdd33209be4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a562beac4843f310dbdc61fdd33209be4">set_sort_by_key_then_relevance</a> (<a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a> *sorter, bool reverse)</td></tr>
<tr class="memdesc:a562beac4843f310dbdc61fdd33209be4"><td class="mdescLeft"> </td><td class="mdescRight">Set the sorting to be by keys generated from values, then by relevance for documents with identical keys. <a href="classXapian_1_1Enquire.html#a562beac4843f310dbdc61fdd33209be4">More...</a><br /></td></tr>
<tr class="separator:a562beac4843f310dbdc61fdd33209be4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a495760d5edc479385b14b463affbff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a5a495760d5edc479385b14b463affbff">set_sort_by_relevance_then_value</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> sort_key, bool reverse)</td></tr>
<tr class="memdesc:a5a495760d5edc479385b14b463affbff"><td class="mdescLeft"> </td><td class="mdescRight">Set the sorting to be by relevance then value. <a href="classXapian_1_1Enquire.html#a5a495760d5edc479385b14b463affbff">More...</a><br /></td></tr>
<tr class="separator:a5a495760d5edc479385b14b463affbff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac64b07e06a24519baf1c495d0edcd0c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#ac64b07e06a24519baf1c495d0edcd0c3">set_sort_by_relevance_then_key</a> (<a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a> *sorter, bool reverse)</td></tr>
<tr class="memdesc:ac64b07e06a24519baf1c495d0edcd0c3"><td class="mdescLeft"> </td><td class="mdescRight">Set the sorting to be by relevance, then by keys generated from values. <a href="classXapian_1_1Enquire.html#ac64b07e06a24519baf1c495d0edcd0c3">More...</a><br /></td></tr>
<tr class="separator:ac64b07e06a24519baf1c495d0edcd0c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27e8f3d6d784cce86059072d27ee4a66"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a27e8f3d6d784cce86059072d27ee4a66">set_time_limit</a> (double time_limit)</td></tr>
<tr class="memdesc:a27e8f3d6d784cce86059072d27ee4a66"><td class="mdescLeft"> </td><td class="mdescRight">Set a time limit for the match. <a href="classXapian_1_1Enquire.html#a27e8f3d6d784cce86059072d27ee4a66">More...</a><br /></td></tr>
<tr class="separator:a27e8f3d6d784cce86059072d27ee4a66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab6fba434e5ddbbea2adcab85ba5ba4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1MSet.html">MSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#aab6fba434e5ddbbea2adcab85ba5ba4a">get_mset</a> (<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> first, <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> maxitems, <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> checkatleast=0, const <a class="el" href="classXapian_1_1RSet.html">RSet</a> *omrset=0, const <a class="el" href="classXapian_1_1MatchDecider.html">MatchDecider</a> *mdecider=0) const</td></tr>
<tr class="memdesc:aab6fba434e5ddbbea2adcab85ba5ba4a"><td class="mdescLeft"> </td><td class="mdescRight">Get (a portion of) the match set for the current query. <a href="classXapian_1_1Enquire.html#aab6fba434e5ddbbea2adcab85ba5ba4a">More...</a><br /></td></tr>
<tr class="separator:aab6fba434e5ddbbea2adcab85ba5ba4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f2e35f79bc731bebfbdaceda17b9892"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1MSet.html">MSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a1f2e35f79bc731bebfbdaceda17b9892">get_mset</a> (<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> first, <a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> maxitems, const <a class="el" href="classXapian_1_1RSet.html">RSet</a> *omrset, const <a class="el" href="classXapian_1_1MatchDecider.html">MatchDecider</a> *mdecider=0) const</td></tr>
<tr class="memdesc:a1f2e35f79bc731bebfbdaceda17b9892"><td class="mdescLeft"> </td><td class="mdescRight">Get (a portion of) the match set for the current query. <a href="classXapian_1_1Enquire.html#a1f2e35f79bc731bebfbdaceda17b9892">More...</a><br /></td></tr>
<tr class="separator:a1f2e35f79bc731bebfbdaceda17b9892"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a533fdccdf99b3545eabb2298f6304385"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ESet.html">ESet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385">get_eset</a> (<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> maxitems, const <a class="el" href="classXapian_1_1RSet.html">RSet</a> &omrset, int flags=0, const <a class="el" href="classXapian_1_1ExpandDecider.html">Xapian::ExpandDecider</a> *edecider=0, double min_wt=0.0) const</td></tr>
<tr class="memdesc:a533fdccdf99b3545eabb2298f6304385"><td class="mdescLeft"> </td><td class="mdescRight">Get the expand set for the given rset. <a href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385">More...</a><br /></td></tr>
<tr class="separator:a533fdccdf99b3545eabb2298f6304385"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8b88f9cc7498fe8aaf5f782e716c666"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ESet.html">ESet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#ae8b88f9cc7498fe8aaf5f782e716c666">get_eset</a> (<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> maxitems, const <a class="el" href="classXapian_1_1RSet.html">RSet</a> &omrset, const <a class="el" href="classXapian_1_1ExpandDecider.html">Xapian::ExpandDecider</a> *edecider) const</td></tr>
<tr class="memdesc:ae8b88f9cc7498fe8aaf5f782e716c666"><td class="mdescLeft"> </td><td class="mdescRight">Get the expand set for the given rset. <a href="classXapian_1_1Enquire.html#ae8b88f9cc7498fe8aaf5f782e716c666">More...</a><br /></td></tr>
<tr class="separator:ae8b88f9cc7498fe8aaf5f782e716c666"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a163ae97d8edb27b1efeafbbf3f997fc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ESet.html">ESet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a163ae97d8edb27b1efeafbbf3f997fc6">get_eset</a> (<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> maxitems, const <a class="el" href="classXapian_1_1RSet.html">RSet</a> &rset, int flags, double k, const <a class="el" href="classXapian_1_1ExpandDecider.html">Xapian::ExpandDecider</a> *edecider=NULL, double min_wt=0.0) const</td></tr>
<tr class="memdesc:a163ae97d8edb27b1efeafbbf3f997fc6"><td class="mdescLeft"> </td><td class="mdescRight">Get the expand set for the given rset. <a href="classXapian_1_1Enquire.html#a163ae97d8edb27b1efeafbbf3f997fc6">More...</a><br /></td></tr>
<tr class="separator:a163ae97d8edb27b1efeafbbf3f997fc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b729c85afb5c0308692facae69ba490"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a3b729c85afb5c0308692facae69ba490">get_matching_terms_begin</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did) const</td></tr>
<tr class="memdesc:a3b729c85afb5c0308692facae69ba490"><td class="mdescLeft"> </td><td class="mdescRight">Get terms which match a given document, by document id. <a href="classXapian_1_1Enquire.html#a3b729c85afb5c0308692facae69ba490">More...</a><br /></td></tr>
<tr class="separator:a3b729c85afb5c0308692facae69ba490"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af067b8c7da43ee6169b77d346fb9730e"><td class="memItemLeft" align="right" valign="top"><a id="af067b8c7da43ee6169b77d346fb9730e"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#af067b8c7da43ee6169b77d346fb9730e">get_matching_terms_end</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a>) const</td></tr>
<tr class="memdesc:af067b8c7da43ee6169b77d346fb9730e"><td class="mdescLeft"> </td><td class="mdescRight">End iterator corresponding to <a class="el" href="classXapian_1_1Enquire.html#a3b729c85afb5c0308692facae69ba490" title="Get terms which match a given document, by document id.">get_matching_terms_begin()</a> <br /></td></tr>
<tr class="separator:af067b8c7da43ee6169b77d346fb9730e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a018a94837e9e26ada6a84ab70b60d574"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a018a94837e9e26ada6a84ab70b60d574">get_matching_terms_begin</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &it) const</td></tr>
<tr class="memdesc:a018a94837e9e26ada6a84ab70b60d574"><td class="mdescLeft"> </td><td class="mdescRight">Get terms which match a given document, by match set item. <a href="classXapian_1_1Enquire.html#a018a94837e9e26ada6a84ab70b60d574">More...</a><br /></td></tr>
<tr class="separator:a018a94837e9e26ada6a84ab70b60d574"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35d2d59126dc1f2a209d48127552ca28"><td class="memItemLeft" align="right" valign="top"><a id="a35d2d59126dc1f2a209d48127552ca28"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a35d2d59126dc1f2a209d48127552ca28">get_matching_terms_end</a> (const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> &) const</td></tr>
<tr class="memdesc:a35d2d59126dc1f2a209d48127552ca28"><td class="mdescLeft"> </td><td class="mdescRight">End iterator corresponding to <a class="el" href="classXapian_1_1Enquire.html#a3b729c85afb5c0308692facae69ba490" title="Get terms which match a given document, by document id.">get_matching_terms_begin()</a> <br /></td></tr>
<tr class="separator:a35d2d59126dc1f2a209d48127552ca28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7618cff968aad8ec4550ff70271dd433"><td class="memItemLeft" align="right" valign="top"><a id="a7618cff968aad8ec4550ff70271dd433"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a7618cff968aad8ec4550ff70271dd433">get_description</a> () const</td></tr>
<tr class="memdesc:a7618cff968aad8ec4550ff70271dd433"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a7618cff968aad8ec4550ff70271dd433"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af28f6824ccaf5b4045da9684e9eecb82"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#af28f6824ccaf5b4045da9684e9eecb82">INCLUDE_QUERY_TERMS</a> = 1</td></tr>
<tr class="memdesc:af28f6824ccaf5b4045da9684e9eecb82"><td class="mdescLeft"> </td><td class="mdescRight">Terms in the query may be returned by <a class="el" href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385" title="Get the expand set for the given rset.">get_eset()</a>. <a href="classXapian_1_1Enquire.html#af28f6824ccaf5b4045da9684e9eecb82">More...</a><br /></td></tr>
<tr class="separator:af28f6824ccaf5b4045da9684e9eecb82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08ae037a8d477d8018d23203cb179914"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Enquire.html#a08ae037a8d477d8018d23203cb179914">USE_EXACT_TERMFREQ</a> = 2</td></tr>
<tr class="memdesc:a08ae037a8d477d8018d23203cb179914"><td class="mdescLeft"> </td><td class="mdescRight">Calculate exact term frequencies in <a class="el" href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385" title="Get the expand set for the given rset.">get_eset()</a>. <a href="classXapian_1_1Enquire.html#a08ae037a8d477d8018d23203cb179914">More...</a><br /></td></tr>
<tr class="separator:a08ae037a8d477d8018d23203cb179914"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides an interface to the information retrieval system for the purpose of searching. </p>
<p>Databases are usually opened lazily, so exceptions may not be thrown where you would expect them to be. You should catch <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> exceptions when calling any method in <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a>.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>will be thrown if an invalid argument is supplied, for example, an unknown database type. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ad87c8d66b4646c6a9b19f4e88fb4296b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad87c8d66b4646c6a9b19f4e88fb4296b">◆ </a></span>docid_order</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296b">Xapian::Enquire::docid_order</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ordering of docids. </p>
<p>Parameter to <a class="el" href="classXapian_1_1Enquire.html#abbf7ff734ff6adcb301e493f6eed803b" title="Set sort order for document IDs.">Enquire::set_docid_order()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad87c8d66b4646c6a9b19f4e88fb4296ba5a930d75a962b5d9c08f59920db4aa8a"></a>ASCENDING </td><td class="fielddoc"><p>docids sort in ascending order (default) </p>
</td></tr>
<tr><td class="fieldname"><a id="ad87c8d66b4646c6a9b19f4e88fb4296ba0cf8b75c1fcd0ab6dbc3af0635a0b104"></a>DESCENDING </td><td class="fielddoc"><p>docids sort in descending order. </p>
</td></tr>
<tr><td class="fieldname"><a id="ad87c8d66b4646c6a9b19f4e88fb4296baccadd30465837795cd7cf9b679df162e"></a>DONT_CARE </td><td class="fielddoc"><p>docids sort in whatever order is most efficient for the backend. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a5a5197e96345339874b2138264320256"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a5197e96345339874b2138264320256">◆ </a></span>Enquire() <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">Xapian::Enquire::Enquire </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Database.html">Database</a> & </td>
<td class="paramname"><em>database</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>Create a <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object. </p>
<p>This specification cannot be changed once the <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> is opened: you must create a new <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object to access a different database, or set of databases.</p>
<p>The database supplied must have been initialised (ie, must not be the result of calling the <a class="el" href="classXapian_1_1Database.html#a24f8197f3ac8bfd8c2526e0b8dff4ff7" title="Create a Database with no databases in.">Database::Database()</a> constructor). If you need to handle a situation where you have no databases gracefully, a database created with DB_BACKEND_INMEMORY can be passed here to provide a completely empty database.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">database</td><td>Specification of the database or databases to use.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>will be thrown if an empty <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object is supplied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a35053eb5e4b367d8f1bb763e03b3c99b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35053eb5e4b367d8f1bb763e03b3c99b">◆ </a></span>Enquire() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::Enquire::Enquire </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Database.html">Database</a> & </td>
<td class="paramname"><em>database</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a> * </td>
<td class="paramname"><em>errorhandler_</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object. </p>
<p>This specification cannot be changed once the <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> is opened: you must create a new <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object to access a different database, or set of databases.</p>
<p>The database supplied must have been initialised (ie, must not be the result of calling the <a class="el" href="classXapian_1_1Database.html#a24f8197f3ac8bfd8c2526e0b8dff4ff7" title="Create a Database with no databases in.">Database::Database()</a> constructor). If you need to handle a situation where you have no databases gracefully, a database created with DB_BACKEND_INMEMORY can be passed here to provide a completely empty database.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">database</td><td>Specification of the database or databases to use. </td></tr>
<tr><td class="paramname">errorhandler_</td><td>This parameter is deprecated (since <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> 1.3.1), and as of 1.3.5 it's ignored completely.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>will be thrown if an empty <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object is supplied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a43b54489c53d26a98d3fde3f1d3aa14f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43b54489c53d26a98d3fde3f1d3aa14f">◆ </a></span>add_matchspy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::add_matchspy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td>
<td class="paramname"><em>spy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a matchspy. </p>
<p>This matchspy will be called with some of the documents which match the query, during the match process. Exactly which of the matching documents are passed to it depends on exactly when certain optimisations occur during the match process, but it can be controlled to some extent by setting the <em>checkatleast</em> parameter to <em><a class="el" href="classXapian_1_1Enquire.html#aab6fba434e5ddbbea2adcab85ba5ba4a" title="Get (a portion of) the match set for the current query.">get_mset()</a></em>.</p>
<p>In particular, if there are enough matching documents, at least the number specified by <em>checkatleast</em> will be passed to the matchspy. This means that you can force the matchspy to be shown all matching documents by setting <em>checkatleast</em> to the number of documents in the database.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">spy</td><td>The <a class="el" href="classXapian_1_1MatchSpy.html" title="Abstract base class for match spies.">MatchSpy</a> subclass to add. The caller must ensure that this remains valid while the <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Enquire</a> object remains active, or until <em><a class="el" href="classXapian_1_1Enquire.html#a1bb73406e3e7749a9e66ebc96ebd13f3" title="Remove all the matchspies.">clear_matchspies()</a></em> is called. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae8b88f9cc7498fe8aaf5f782e716c666"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8b88f9cc7498fe8aaf5f782e716c666">◆ </a></span>get_eset() <span class="overload">[1/3]</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_1ESet.html">ESet</a> Xapian::Enquire::get_eset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>maxitems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1RSet.html">RSet</a> & </td>
<td class="paramname"><em>omrset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ExpandDecider.html">Xapian::ExpandDecider</a> * </td>
<td class="paramname"><em>edecider</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the expand set for the given rset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxitems</td><td>the maximum number of items to return. </td></tr>
<tr><td class="paramname">omrset</td><td>the relevance set to use when performing the expand operation. </td></tr>
<tr><td class="paramname">edecider</td><td>a decision functor to use to decide whether a given term should be put in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object containing the results of the expand.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>See class documentation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a533fdccdf99b3545eabb2298f6304385"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a533fdccdf99b3545eabb2298f6304385">◆ </a></span>get_eset() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESet.html">ESet</a> Xapian::Enquire::get_eset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>maxitems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1RSet.html">RSet</a> & </td>
<td class="paramname"><em>omrset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ExpandDecider.html">Xapian::ExpandDecider</a> * </td>
<td class="paramname"><em>edecider</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>min_wt</em> = <code>0.0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the expand set for the given rset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxitems</td><td>the maximum number of items to return. </td></tr>
<tr><td class="paramname">omrset</td><td>the relevance set to use when performing the expand operation. </td></tr>
<tr><td class="paramname">flags</td><td>zero or more of these values |-ed together:<ul>
<li><a class="el" href="classXapian_1_1Enquire.html#af28f6824ccaf5b4045da9684e9eecb82" title="Terms in the query may be returned by get_eset().">Xapian::Enquire::INCLUDE_QUERY_TERMS</a> query terms may be returned from expand</li>
<li><a class="el" href="classXapian_1_1Enquire.html#a08ae037a8d477d8018d23203cb179914" title="Calculate exact term frequencies in get_eset().">Xapian::Enquire::USE_EXACT_TERMFREQ</a> for multi dbs, calculate the exact termfreq; otherwise an approximation is used which can greatly improve efficiency, but still returns good results. </li>
</ul>
</td></tr>
<tr><td class="paramname">edecider</td><td>a decision functor to use to decide whether a given term should be put in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> </td></tr>
<tr><td class="paramname">min_wt</td><td>the minimum weight for included terms</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object containing the results of the expand.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>See class documentation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a163ae97d8edb27b1efeafbbf3f997fc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a163ae97d8edb27b1efeafbbf3f997fc6">◆ </a></span>get_eset() <span class="overload">[3/3]</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_1ESet.html">ESet</a> Xapian::Enquire::get_eset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>maxitems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1RSet.html">RSet</a> & </td>
<td class="paramname"><em>rset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ExpandDecider.html">Xapian::ExpandDecider</a> * </td>
<td class="paramname"><em>edecider</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>min_wt</em> = <code>0.0</code> </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the expand set for the given rset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxitems</td><td>the maximum number of items to return. </td></tr>
<tr><td class="paramname">rset</td><td>the relevance set to use when performing the expand operation. </td></tr>
<tr><td class="paramname">flags</td><td>zero or more of these values |-ed together:<ul>
<li><a class="el" href="classXapian_1_1Enquire.html#af28f6824ccaf5b4045da9684e9eecb82" title="Terms in the query may be returned by get_eset().">Xapian::Enquire::INCLUDE_QUERY_TERMS</a> query terms may be returned from expand</li>
<li><a class="el" href="classXapian_1_1Enquire.html#a08ae037a8d477d8018d23203cb179914" title="Calculate exact term frequencies in get_eset().">Xapian::Enquire::USE_EXACT_TERMFREQ</a> for multi dbs, calculate the exact termfreq; otherwise an approximation is used which can greatly improve efficiency, but still returns good results. </li>
</ul>
</td></tr>
<tr><td class="paramname">k</td><td>the parameter k in the query expansion algorithm (default is 1.0) </td></tr>
<tr><td class="paramname">edecider</td><td>a decision functor to use to decide whether a given term should be put in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a></td></tr>
<tr><td class="paramname">min_wt</td><td>the minimum weight for included terms</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a> object containing the results of the expand.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>See class documentation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a018a94837e9e26ada6a84ab70b60d574"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a018a94837e9e26ada6a84ab70b60d574">◆ </a></span>get_matching_terms_begin() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> Xapian::Enquire::get_matching_terms_begin </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MSetIterator.html">MSetIterator</a> & </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get terms which match a given document, by match set item. </p>
<p>This method returns the terms in the current query which match the given document.</p>
<p>If the underlying database has suitable support, using this call (rather than passing a <a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f" title="A unique identifier for a document.">Xapian::docid</a>) will enable the system to ensure that the correct data is returned, and that the document has not been deleted or changed since the query was performed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">it</td><td>The iterator for which to retrieve the matching terms.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator returning the terms which match the document. The terms will be returned (as far as this makes any sense) in the same order as the terms in the query. Terms will not occur more than once, even if they do in the query.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>See class documentation. </td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DocNotFoundError.html" title="Indicates an attempt to access a document not present in the database.">Xapian::DocNotFoundError</a></td><td>The document specified could not be found in the database. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3b729c85afb5c0308692facae69ba490"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b729c85afb5c0308692facae69ba490">◆ </a></span>get_matching_terms_begin() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> Xapian::Enquire::get_matching_terms_begin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td>
<td class="paramname"><em>did</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get terms which match a given document, by document id. </p>
<p>This method returns the terms in the current query which match the given document.</p>
<p>It is possible for the document to have been removed from the database between the time it is returned in an <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>, and the time that this call is made. If possible, you should specify an <a class="el" href="classXapian_1_1MSetIterator.html" title="Iterator over a Xapian::MSet.">MSetIterator</a> instead of a <a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f" title="A unique identifier for a document.">Xapian::docid</a>, since this will enable database backends with suitable support to prevent this occurring.</p>
<p>Note that a query does not need to have been run in order to make this call.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">did</td><td>The document id for which to retrieve the matching terms.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An iterator returning the terms which match the document. The terms will be returned (as far as this makes any sense) in the same order as the terms in the query. Terms will not occur more than once, even if they do in the query.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>See class documentation. </td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DocNotFoundError.html" title="Indicates an attempt to access a document not present in the database.">Xapian::DocNotFoundError</a></td><td>The document specified could not be found in the database. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1f2e35f79bc731bebfbdaceda17b9892"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f2e35f79bc731bebfbdaceda17b9892">◆ </a></span>get_mset() <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_1MSet.html">MSet</a> Xapian::Enquire::get_mset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td>
<td class="paramname"><em>maxitems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1RSet.html">RSet</a> * </td>
<td class="paramname"><em>omrset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MatchDecider.html">MatchDecider</a> * </td>
<td class="paramname"><em>mdecider</em> = <code>0</code> </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get (a portion of) the match set for the current query. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">first</td><td>the first item in the result set to return. A value of zero corresponds to the first item returned being that with the highest score. A value of 10 corresponds to the first 10 items being ignored, and the returned items starting at the eleventh. </td></tr>
<tr><td class="paramname">maxitems</td><td>the maximum number of items to return. If you want all matches, then you can pass the result of calling get_doccount() on the <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object (though if you are doing this so you can filter results, you are likely to get much better performance by using <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a>'s match-time filtering features instead). You can pass 0 for maxitems which will give you an empty <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a> with valid statistics (such as get_matches_estimated()) calculated without looking at any postings, which is very quick, but means the estimates may be more approximate and the bounds may be much looser. </td></tr>
<tr><td class="paramname">omrset</td><td>the relevance set to use when performing the query. </td></tr>
<tr><td class="paramname">mdecider</td><td>a decision functor to use to decide whether a given document should be put in the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">Xapian::MSet</a> object containing the results of the query.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>See class documentation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aab6fba434e5ddbbea2adcab85ba5ba4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab6fba434e5ddbbea2adcab85ba5ba4a">◆ </a></span>get_mset() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1MSet.html">MSet</a> Xapian::Enquire::get_mset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td>
<td class="paramname"><em>maxitems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td>
<td class="paramname"><em>checkatleast</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1RSet.html">RSet</a> * </td>
<td class="paramname"><em>omrset</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1MatchDecider.html">MatchDecider</a> * </td>
<td class="paramname"><em>mdecider</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get (a portion of) the match set for the current query. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">first</td><td>the first item in the result set to return. A value of zero corresponds to the first item returned being that with the highest score. A value of 10 corresponds to the first 10 items being ignored, and the returned items starting at the eleventh. </td></tr>
<tr><td class="paramname">maxitems</td><td>the maximum number of items to return. If you want all matches, then you can pass the result of calling get_doccount() on the <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object (though if you are doing this so you can filter results, you are likely to get much better performance by using <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a>'s match-time filtering features instead). You can pass 0 for maxitems which will give you an empty <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a> with valid statistics (such as get_matches_estimated()) calculated without looking at any postings, which is very quick, but means the estimates may be more approximate and the bounds may be much looser. </td></tr>
<tr><td class="paramname">checkatleast</td><td>the minimum number of items to check. Because the matcher optimises, it won't consider every document which might match, so the total number of matches is estimated. Setting checkatleast forces it to consider at least this many matches and so allows for reliable paging links. </td></tr>
<tr><td class="paramname">omrset</td><td>the relevance set to use when performing the query. </td></tr>
<tr><td class="paramname">mdecider</td><td>a decision functor to use to decide whether a given document should be put in the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">Xapian::MSet</a> object containing the results of the query.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></td><td>See class documentation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6f27e1e333d6698e597b1d754c686ebf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f27e1e333d6698e597b1d754c686ebf">◆ </a></span>get_query()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1Query.html">Xapian::Query</a>& Xapian::Enquire::get_query </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current query. </p>
<p>If called before <a class="el" href="classXapian_1_1Enquire.html#a1148d960120662e5543e2a2b12620318" title="Set the query to run.">set_query()</a>, this will return a default initialised <a class="el" href="classXapian_1_1Query.html" title="Class representing a query.">Query</a> object. </p>
</div>
</div>
<a id="a117ee547f5908e952e2e72d5a986d3bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a117ee547f5908e952e2e72d5a986d3bb">◆ </a></span>set_collapse_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_collapse_key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>collapse_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td>
<td class="paramname"><em>collapse_max</em> = <code>1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the collapse key to use for queries. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">collapse_key</td><td>value number to collapse on - at most one <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a> entry with each particular value will be returned (default is <a class="el" href="namespaceXapian.html#a0a75ef120e641c77f703e60f595ffda2" title="Reserved value to indicate "no valueno".">Xapian::BAD_VALUENO</a> which means no collapsing).</td></tr>
<tr><td class="paramname">collapse_max</td><td>Max number of items with the same key to leave after collapsing (default 1).</td></tr>
</table>
</dd>
</dl>
<p>The <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a> returned by <a class="el" href="classXapian_1_1Enquire.html#aab6fba434e5ddbbea2adcab85ba5ba4a" title="Get (a portion of) the match set for the current query.">get_mset()</a> will have only the "best" (at most) <em>collapse_max</em> entries with each particular value of <em>collapse_key</em> ("best" being highest ranked - i.e. highest weight or highest sorting key).</p>
<p>An example use might be to create a value for each document containing an MD5 hash of the document contents. Then duplicate documents from different sources can be eliminated at search time by collapsing with <em>collapse_max</em> = 1 (it's better to eliminate duplicates at index time, but this may not be always be possible - for example the search may be over more than one <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> database).</p>
<p>Another use is to group matches in a particular category (e.g. you might collapse a mailing list search on the Subject: so that there's only one result per discussion thread). In this case you can use get_collapse_count() to give the user some idea how many other results there are. And if you index the Subject: as a boolean term as well as putting it in a value, you can offer a link to a non-collapsed search restricted to that thread using a boolean filter. </p>
</div>
</div>
<a id="a70bc7137850fe46d98e62c1020539d22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70bc7137850fe46d98e62c1020539d22">◆ </a></span>set_cutoff()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_cutoff </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>percent_cutoff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>weight_cutoff</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the percentage and/or weight cutoffs. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">percent_cutoff</td><td>Minimum percentage score for returned documents. If a document has a lower percentage score than this, it will not appear in the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>. If your intention is to return only matches which contain all the terms in the query, then it's more efficient to use <a class="el" href="classXapian_1_1Query.html#a7e7b6b8ad0c915c2364578dfaaf6100bab99aad2dfc85eccc56163bc65eb0fdda" title="Match only documents which all subqueries match.">Xapian::Query::OP_AND</a> instead of <a class="el" href="classXapian_1_1Query.html#a7e7b6b8ad0c915c2364578dfaaf6100bac50e54f3dd9dc59dab7daa2c50cf631b" title="Match documents which at least one subquery matches.">Xapian::Query::OP_OR</a> in the query than to use set_cutoff(100). (default 0 => no percentage cut-off). </td></tr>
<tr><td class="paramname">weight_cutoff</td><td>Minimum weight for a document to be returned. If a document has a lower score that this, it will not appear in the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>. It is usually only possible to choose an appropriate weight for cutoff based on the results of a previous run of the same query; this is thus mainly useful for alerting operations. The other potential use is with a user specified weighting scheme. (default 0 => no weight cut-off). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abbf7ff734ff6adcb301e493f6eed803b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbf7ff734ff6adcb301e493f6eed803b">◆ </a></span>set_docid_order()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_docid_order </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296b">docid_order</a> </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set sort order for document IDs. </p>
<p>This order only has an effect on documents which would otherwise have equal rank. When ordering by relevance without a sort key, this means documents with equal weight. For a boolean match with no sort key, this means all documents. And if a sort key is used, this means documents with the same sort key (and also equal weight if ordering on relevance before or after the sort key).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>This can be:<ul>
<li><a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296ba5a930d75a962b5d9c08f59920db4aa8a" title="docids sort in ascending order (default)">Xapian::Enquire::ASCENDING</a> docids sort in ascending order (default)</li>
<li><a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296ba0cf8b75c1fcd0ab6dbc3af0635a0b104" title="docids sort in descending order.">Xapian::Enquire::DESCENDING</a> docids sort in descending order</li>
<li><p class="startli"><a class="el" href="classXapian_1_1Enquire.html#ad87c8d66b4646c6a9b19f4e88fb4296baccadd30465837795cd7cf9b679df162e" title="docids sort in whatever order is most efficient for the backend.">Xapian::Enquire::DONT_CARE</a> docids sort in whatever order is most efficient for the backend</p>
<p class="startli">Note: If you add documents in strict date order, then a boolean search - i.e. set_weighting_scheme(Xapian::BoolWeight()) - with set_docid_order(Xapian::Enquire::DESCENDING) is an efficient way to perform "sort by date, newest first", and with set_docid_order(Xapian::Enquire::ASCENDING) a very efficient way to perform "sort by date, oldest first". </p>
</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a002147c94aff96d5d0cb394f018b6363"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a002147c94aff96d5d0cb394f018b6363">◆ </a></span>set_expansion_scheme()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_expansion_scheme </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>eweightname_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>expand_k_</em> = <code>1.0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the weighting scheme to use for expansion. </p>
<p>If you don't call this method, the default is as if you'd used:</p>
<p>get_expansion_scheme("trad");</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eweightname_</td><td>A string in lowercase specifying the name of the scheme to be used. The following schemes are currently available: "bo1" : The Bo1 scheme for query expansion. "trad" : The <a class="el" href="classXapian_1_1TradWeight.html" title="Xapian::Weight subclass implementing the traditional probabilistic formula.">TradWeight</a> scheme for query expansion. </td></tr>
<tr><td class="paramname">expand_k_</td><td>The parameter required for <a class="el" href="classXapian_1_1TradWeight.html" title="Xapian::Weight subclass implementing the traditional probabilistic formula.">TradWeight</a> query expansion. A default value of 1.0 is used if none is specified. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1148d960120662e5543e2a2b12620318"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1148d960120662e5543e2a2b12620318">◆ </a></span>set_query()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_query </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Query.html">Xapian::Query</a> & </td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>qlen</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the query to run. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td>the new query to run. </td></tr>
<tr><td class="paramname">qlen</td><td>the query length to use in weight calculations - by default the sum of the wqf of all terms is used. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0bcb7086d8633fc035c6e5d094e45d39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bcb7086d8633fc035c6e5d094e45d39">◆ </a></span>set_sort_by_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_sort_by_key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a> * </td>
<td class="paramname"><em>sorter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>reverse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sorting to be by key generated from values only. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sorter</td><td>The functor to use for generating keys.</td></tr>
<tr><td class="paramname">reverse</td><td>If true, reverses the sort order. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a562beac4843f310dbdc61fdd33209be4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a562beac4843f310dbdc61fdd33209be4">◆ </a></span>set_sort_by_key_then_relevance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_sort_by_key_then_relevance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a> * </td>
<td class="paramname"><em>sorter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>reverse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sorting to be by keys generated from values, then by relevance for documents with identical keys. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sorter</td><td>The functor to use for generating keys.</td></tr>
<tr><td class="paramname">reverse</td><td>If true, reverses the sort order. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a80a33a28791c05167204706c1a9d986b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80a33a28791c05167204706c1a9d986b">◆ </a></span>set_sort_by_relevance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_sort_by_relevance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sorting to be by relevance only. </p>
<p>This is the default. </p>
</div>
</div>
<a id="ac64b07e06a24519baf1c495d0edcd0c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac64b07e06a24519baf1c495d0edcd0c3">◆ </a></span>set_sort_by_relevance_then_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_sort_by_relevance_then_key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a> * </td>
<td class="paramname"><em>sorter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>reverse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sorting to be by relevance, then by keys generated from values. </p>
<p>Note that with the default BM25 weighting scheme parameters, non-identical documents will rarely have the same weight, so this setting will give very similar results to <a class="el" href="classXapian_1_1Enquire.html#a80a33a28791c05167204706c1a9d986b" title="Set the sorting to be by relevance only.">set_sort_by_relevance()</a>. It becomes more useful with particular BM25 parameter settings (e.g. BM25Weight(1,0,1,0,0)) or custom weighting schemes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sorter</td><td>The functor to use for generating keys.</td></tr>
<tr><td class="paramname">reverse</td><td>If true, reverses the sort order of the generated keys. Beware that in 1.2.16 and earlier, the sense of this parameter was incorrectly inverted and inconsistent with the other set_sort_by_... methods. This was fixed in 1.2.17, so make that version a minimum requirement if this detail matters to your application. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5a495760d5edc479385b14b463affbff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a495760d5edc479385b14b463affbff">◆ </a></span>set_sort_by_relevance_then_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_sort_by_relevance_then_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>sort_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>reverse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sorting to be by relevance then value. </p>
<p>Note that sorting by values uses a string comparison, so to use this to sort by a numeric value you'll need to store the numeric values in a manner which sorts appropriately. For example, you could use <a class="el" href="namespaceXapian.html#a29a741b4cda98e10ed5f2fc784039065" title="Convert a floating point number to a string, preserving sort order.">Xapian::sortable_serialise()</a> (which works for floating point numbers as well as integers), or store numbers padded with leading zeros or spaces, or with the number of digits prepended.</p>
<p>Note that with the default BM25 weighting scheme parameters, non-identical documents will rarely have the same weight, so this setting will give very similar results to <a class="el" href="classXapian_1_1Enquire.html#a80a33a28791c05167204706c1a9d986b" title="Set the sorting to be by relevance only.">set_sort_by_relevance()</a>. It becomes more useful with particular BM25 parameter settings (e.g. BM25Weight(1,0,1,0,0)) or custom weighting schemes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sort_key</td><td>value number to sort on.</td></tr>
<tr><td class="paramname">reverse</td><td>If true, reverses the sort order of sort_key. Beware that in 1.2.16 and earlier, the sense of this parameter was incorrectly inverted and inconsistent with the other set_sort_by_... methods. This was fixed in 1.2.17, so make that version a minimum requirement if this detail matters to your application. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab10384fabd51eebd8174f916563e3f7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab10384fabd51eebd8174f916563e3f7a">◆ </a></span>set_sort_by_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_sort_by_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>sort_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>reverse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sorting to be by value only. </p>
<p>Note that sorting by values uses a string comparison, so to use this to sort by a numeric value you'll need to store the numeric values in a manner which sorts appropriately. For example, you could use <a class="el" href="namespaceXapian.html#a29a741b4cda98e10ed5f2fc784039065" title="Convert a floating point number to a string, preserving sort order.">Xapian::sortable_serialise()</a> (which works for floating point numbers as well as integers), or store numbers padded with leading zeros or spaces, or with the number of digits prepended.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sort_key</td><td>value number to sort on.</td></tr>
<tr><td class="paramname">reverse</td><td>If true, reverses the sort order. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa921b3c9386fbe2ddfd7dbbf130f9391"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa921b3c9386fbe2ddfd7dbbf130f9391">◆ </a></span>set_sort_by_value_then_relevance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_sort_by_value_then_relevance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>sort_key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>reverse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the sorting to be by value, then by relevance for documents with the same value. </p>
<p>Note that sorting by values uses a string comparison, so to use this to sort by a numeric value you'll need to store the numeric values in a manner which sorts appropriately. For example, you could use <a class="el" href="namespaceXapian.html#a29a741b4cda98e10ed5f2fc784039065" title="Convert a floating point number to a string, preserving sort order.">Xapian::sortable_serialise()</a> (which works for floating point numbers as well as integers), or store numbers padded with leading zeros or spaces, or with the number of digits prepended.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sort_key</td><td>value number to sort on.</td></tr>
<tr><td class="paramname">reverse</td><td>If true, reverses the sort order. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a27e8f3d6d784cce86059072d27ee4a66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27e8f3d6d784cce86059072d27ee4a66">◆ </a></span>set_time_limit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_time_limit </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>time_limit</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a time limit for the match. </p>
<p>Matches with check_at_least set high can take a long time in some cases. You can set a time limit on this, after which check_at_least will be turned off.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time_limit</td><td>time in seconds after which to disable check_at_least (default: 0.0 which means no time limit)</td></tr>
</table>
</dd>
</dl>
<p>Limitations:</p>
<p>This feature is currently supported on platforms which support POSIX interval timers. Interaction with the remote backend when using multiple databases may have bugs. There's not currently a way to force the match to end after a certain time. </p>
</div>
</div>
<a id="ad5c72e6f34c5c2da5f0b8c79736704ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5c72e6f34c5c2da5f0b8c79736704ab">◆ </a></span>set_weighting_scheme()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Enquire::set_weighting_scheme </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Weight.html">Weight</a> & </td>
<td class="paramname"><em>weight_</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the weighting scheme to use for queries. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">weight_</td><td>the new weighting scheme. If no weighting scheme is specified, the default is BM25 with the default parameters. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af28f6824ccaf5b4045da9684e9eecb82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af28f6824ccaf5b4045da9684e9eecb82">◆ </a></span>INCLUDE_QUERY_TERMS</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int Xapian::Enquire::INCLUDE_QUERY_TERMS = 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Terms in the query may be returned by <a class="el" href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385" title="Get the expand set for the given rset.">get_eset()</a>. </p>
<p>The original intended use for <a class="el" href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385" title="Get the expand set for the given rset.">Enquire::get_eset()</a> is for query expansion - suggesting terms to add to the query, generally with the aim of improving recall (i.e. finding more of the relevant documents), so by default terms already in the query won't be returned in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing a list of search results.">ESet</a>. For some uses you might want to consider all terms, and this flag allows you to specify that. </p>
</div>
</div>
<a id="a08ae037a8d477d8018d23203cb179914"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08ae037a8d477d8018d23203cb179914">◆ </a></span>USE_EXACT_TERMFREQ</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int Xapian::Enquire::USE_EXACT_TERMFREQ = 2</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate exact term frequencies in <a class="el" href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385" title="Get the expand set for the given rset.">get_eset()</a>. </p>
<p>By default, when working over multiple databases, <a class="el" href="classXapian_1_1Enquire.html#a533fdccdf99b3545eabb2298f6304385" title="Get the expand set for the given rset.">Enquire::get_eset()</a> uses an approximation to the termfreq to improve efficiency. This should still return good results, but if you want to calculate the exact combined termfreq then you can use this flag. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="enquire_8h.html">enquire.h</a></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>
|
