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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::ValueCountMatchSpy Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">xapian-core
 <span id="projectnumber">1.4.22</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html">ValueCountMatchSpy</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1ValueCountMatchSpy-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::ValueCountMatchSpy Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Class for counting the frequencies of values in the matching documents.
<a href="classXapian_1_1ValueCountMatchSpy.html#details">More...</a></p>
<p><code>#include <matchspy.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::ValueCountMatchSpy:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classXapian_1_1ValueCountMatchSpy__inherit__graph.png" border="0" usemap="#aXapian_1_1ValueCountMatchSpy_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1ValueCountMatchSpy_inherit__map" id="aXapian_1_1ValueCountMatchSpy_inherit__map">
<area shape="rect" title="Class for counting the frequencies of values in the matching documents." alt="" coords="5,169,220,196"/>
<area shape="rect" href="classXapian_1_1MatchSpy.html" title="Abstract base class for match spies." alt="" coords="43,95,182,121"/>
<area shape="rect" title=" " alt="" coords="35,5,190,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abe9390bb136f7c380126dc89c463795d"><td class="memItemLeft" align="right" valign="top"><a id="abe9390bb136f7c380126dc89c463795d" name="abe9390bb136f7c380126dc89c463795d"></a>
 </td><td class="memItemRight" valign="bottom"><b>ValueCountMatchSpy</b> ()</td></tr>
<tr class="memdesc:abe9390bb136f7c380126dc89c463795d"><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty <a class="el" href="classXapian_1_1ValueCountMatchSpy.html" title="Class for counting the frequencies of values in the matching documents.">ValueCountMatchSpy</a>. <br /></td></tr>
<tr class="separator:abe9390bb136f7c380126dc89c463795d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1cb660b864dfa6d72cffbe587f5a8b6"><td class="memItemLeft" align="right" valign="top"><a id="ad1cb660b864dfa6d72cffbe587f5a8b6" name="ad1cb660b864dfa6d72cffbe587f5a8b6"></a>
 </td><td class="memItemRight" valign="bottom"><b>ValueCountMatchSpy</b> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_)</td></tr>
<tr class="memdesc:ad1cb660b864dfa6d72cffbe587f5a8b6"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1MatchSpy.html" title="Abstract base class for match spies.">MatchSpy</a> which counts the values in a particular slot. <br /></td></tr>
<tr class="separator:ad1cb660b864dfa6d72cffbe587f5a8b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae58140fcb445ad90165e96601ceb4564"><td class="memItemLeft" align="right" valign="top"><a id="ae58140fcb445ad90165e96601ceb4564" name="ae58140fcb445ad90165e96601ceb4564"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>get_total</b> () const</td></tr>
<tr class="memdesc:ae58140fcb445ad90165e96601ceb4564"><td class="mdescLeft"> </td><td class="mdescRight">Return the total number of documents tallied. <br /></td></tr>
<tr class="separator:ae58140fcb445ad90165e96601ceb4564"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebb501034b5d1f37f69eb2fcb793742b"><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_1ValueCountMatchSpy.html#aebb501034b5d1f37f69eb2fcb793742b">values_begin</a> () const</td></tr>
<tr class="memdesc:aebb501034b5d1f37f69eb2fcb793742b"><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator over the values seen in the slot. <a href="classXapian_1_1ValueCountMatchSpy.html#aebb501034b5d1f37f69eb2fcb793742b">More...</a><br /></td></tr>
<tr class="separator:aebb501034b5d1f37f69eb2fcb793742b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ababa710cda287c510353b5fdb7c8493f"><td class="memItemLeft" align="right" valign="top"><a id="ababa710cda287c510353b5fdb7c8493f" name="ababa710cda287c510353b5fdb7c8493f"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><b>values_end</b> () const</td></tr>
<tr class="memdesc:ababa710cda287c510353b5fdb7c8493f"><td class="mdescLeft"> </td><td class="mdescRight">End iterator corresponding to <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#aebb501034b5d1f37f69eb2fcb793742b" title="Get an iterator over the values seen in the slot.">values_begin()</a> <br /></td></tr>
<tr class="separator:ababa710cda287c510353b5fdb7c8493f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84b4fadce263dbbaf80338969286248d"><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_1ValueCountMatchSpy.html#a84b4fadce263dbbaf80338969286248d">top_values_begin</a> (size_t maxvalues) const</td></tr>
<tr class="memdesc:a84b4fadce263dbbaf80338969286248d"><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator over the most frequent values seen in the slot. <a href="classXapian_1_1ValueCountMatchSpy.html#a84b4fadce263dbbaf80338969286248d">More...</a><br /></td></tr>
<tr class="separator:a84b4fadce263dbbaf80338969286248d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace7bfc3489554fee528e3f16cf682b72"><td class="memItemLeft" align="right" valign="top"><a id="ace7bfc3489554fee528e3f16cf682b72" name="ace7bfc3489554fee528e3f16cf682b72"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><b>top_values_end</b> (size_t) const</td></tr>
<tr class="memdesc:ace7bfc3489554fee528e3f16cf682b72"><td class="mdescLeft"> </td><td class="mdescRight">End iterator corresponding to <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a84b4fadce263dbbaf80338969286248d" title="Get an iterator over the most frequent values seen in the slot.">top_values_begin()</a> <br /></td></tr>
<tr class="separator:ace7bfc3489554fee528e3f16cf682b72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4635086013fa8146d6f7e9176bdc1623"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a4635086013fa8146d6f7e9176bdc1623">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc, double wt)</td></tr>
<tr class="memdesc:a4635086013fa8146d6f7e9176bdc1623"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of virtual operator(). <a href="classXapian_1_1ValueCountMatchSpy.html#a4635086013fa8146d6f7e9176bdc1623">More...</a><br /></td></tr>
<tr class="separator:a4635086013fa8146d6f7e9176bdc1623"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4f298ec9a4f0bb58ae1ded83e4db46c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#ad4f298ec9a4f0bb58ae1ded83e4db46c">clone</a> () const</td></tr>
<tr class="memdesc:ad4f298ec9a4f0bb58ae1ded83e4db46c"><td class="mdescLeft"> </td><td class="mdescRight">Clone the match spy. <a href="classXapian_1_1ValueCountMatchSpy.html#ad4f298ec9a4f0bb58ae1ded83e4db46c">More...</a><br /></td></tr>
<tr class="separator:ad4f298ec9a4f0bb58ae1ded83e4db46c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2baaef80a28006a1ef935036bd9b8f5"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#aa2baaef80a28006a1ef935036bd9b8f5">name</a> () const</td></tr>
<tr class="memdesc:aa2baaef80a28006a1ef935036bd9b8f5"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of this match spy. <a href="classXapian_1_1ValueCountMatchSpy.html#aa2baaef80a28006a1ef935036bd9b8f5">More...</a><br /></td></tr>
<tr class="separator:aa2baaef80a28006a1ef935036bd9b8f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bc38753f440c8da6ff719ae17b7d671"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a4bc38753f440c8da6ff719ae17b7d671">serialise</a> () const</td></tr>
<tr class="memdesc:a4bc38753f440c8da6ff719ae17b7d671"><td class="mdescLeft"> </td><td class="mdescRight">Return this object's parameters serialised as a single string. <a href="classXapian_1_1ValueCountMatchSpy.html#a4bc38753f440c8da6ff719ae17b7d671">More...</a><br /></td></tr>
<tr class="separator:a4bc38753f440c8da6ff719ae17b7d671"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71a6d28e5c39b6453678d502a72eb10e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a71a6d28e5c39b6453678d502a72eb10e">unserialise</a> (const std::string &serialised, const <a class="el" href="classXapian_1_1Registry.html">Registry</a> &context) const</td></tr>
<tr class="memdesc:a71a6d28e5c39b6453678d502a72eb10e"><td class="mdescLeft"> </td><td class="mdescRight">Unserialise parameters. <a href="classXapian_1_1ValueCountMatchSpy.html#a71a6d28e5c39b6453678d502a72eb10e">More...</a><br /></td></tr>
<tr class="separator:a71a6d28e5c39b6453678d502a72eb10e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04260d9ea536a77f553d4e70f258d42f"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a04260d9ea536a77f553d4e70f258d42f">serialise_results</a> () const</td></tr>
<tr class="memdesc:a04260d9ea536a77f553d4e70f258d42f"><td class="mdescLeft"> </td><td class="mdescRight">Serialise the results of this match spy. <a href="classXapian_1_1ValueCountMatchSpy.html#a04260d9ea536a77f553d4e70f258d42f">More...</a><br /></td></tr>
<tr class="separator:a04260d9ea536a77f553d4e70f258d42f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a532aa4b7592750ce833a4a8031666119"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a532aa4b7592750ce833a4a8031666119">merge_results</a> (const std::string &serialised)</td></tr>
<tr class="memdesc:a532aa4b7592750ce833a4a8031666119"><td class="mdescLeft"> </td><td class="mdescRight">Unserialise some results, and merge them into this matchspy. <a href="classXapian_1_1ValueCountMatchSpy.html#a532aa4b7592750ce833a4a8031666119">More...</a><br /></td></tr>
<tr class="separator:a532aa4b7592750ce833a4a8031666119"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a265b88f764f1462947233db9105a5d25"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a265b88f764f1462947233db9105a5d25">get_description</a> () const</td></tr>
<tr class="memdesc:a265b88f764f1462947233db9105a5d25"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="classXapian_1_1ValueCountMatchSpy.html#a265b88f764f1462947233db9105a5d25">More...</a><br /></td></tr>
<tr class="separator:a265b88f764f1462947233db9105a5d25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1MatchSpy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1MatchSpy')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1MatchSpy.html">Xapian::MatchSpy</a></td></tr>
<tr class="memitem:a6f1b24d1ef113cf625ce75b6320212ed inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top"><a id="a6f1b24d1ef113cf625ce75b6320212ed" name="a6f1b24d1ef113cf625ce75b6320212ed"></a>
 </td><td class="memItemRight" valign="bottom"><b>MatchSpy</b> ()</td></tr>
<tr class="memdesc:a6f1b24d1ef113cf625ce75b6320212ed inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, needed by subclass constructors. <br /></td></tr>
<tr class="separator:a6f1b24d1ef113cf625ce75b6320212ed inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33eef1126286858ed6c9908028dcae5b inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top"><a id="a33eef1126286858ed6c9908028dcae5b" name="a33eef1126286858ed6c9908028dcae5b"></a>
virtual </td><td class="memItemRight" valign="bottom"><b>~MatchSpy</b> ()</td></tr>
<tr class="memdesc:a33eef1126286858ed6c9908028dcae5b inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor, because we have virtual methods. <br /></td></tr>
<tr class="separator:a33eef1126286858ed6c9908028dcae5b inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46228fa80cf68ce528d2023ab38b642a inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#a46228fa80cf68ce528d2023ab38b642a">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc, double wt)=0</td></tr>
<tr class="memdesc:a46228fa80cf68ce528d2023ab38b642a inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Register a document with the match spy. <a href="classXapian_1_1MatchSpy.html#a46228fa80cf68ce528d2023ab38b642a">More...</a><br /></td></tr>
<tr class="separator:a46228fa80cf68ce528d2023ab38b642a inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa09d7673ed421f8b16fa6d79db5ad205 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#aa09d7673ed421f8b16fa6d79db5ad205">clone</a> () const</td></tr>
<tr class="memdesc:aa09d7673ed421f8b16fa6d79db5ad205 inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Clone the match spy. <a href="classXapian_1_1MatchSpy.html#aa09d7673ed421f8b16fa6d79db5ad205">More...</a><br /></td></tr>
<tr class="separator:aa09d7673ed421f8b16fa6d79db5ad205 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8bb708d4d564af2c21c36b9ed6ea868f inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#a8bb708d4d564af2c21c36b9ed6ea868f">name</a> () const</td></tr>
<tr class="memdesc:a8bb708d4d564af2c21c36b9ed6ea868f inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of this match spy. <a href="classXapian_1_1MatchSpy.html#a8bb708d4d564af2c21c36b9ed6ea868f">More...</a><br /></td></tr>
<tr class="separator:a8bb708d4d564af2c21c36b9ed6ea868f inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9920929d6343a17a14885c4a2d2e3cb inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#af9920929d6343a17a14885c4a2d2e3cb">serialise</a> () const</td></tr>
<tr class="memdesc:af9920929d6343a17a14885c4a2d2e3cb inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Return this object's parameters serialised as a single string. <a href="classXapian_1_1MatchSpy.html#af9920929d6343a17a14885c4a2d2e3cb">More...</a><br /></td></tr>
<tr class="separator:af9920929d6343a17a14885c4a2d2e3cb inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e50f26f433edb87324e43e0af60aff4 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#a3e50f26f433edb87324e43e0af60aff4">unserialise</a> (const std::string &serialised, const <a class="el" href="classXapian_1_1Registry.html">Registry</a> &context) const</td></tr>
<tr class="memdesc:a3e50f26f433edb87324e43e0af60aff4 inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Unserialise parameters. <a href="classXapian_1_1MatchSpy.html#a3e50f26f433edb87324e43e0af60aff4">More...</a><br /></td></tr>
<tr class="separator:a3e50f26f433edb87324e43e0af60aff4 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6f5262d41b6c96ef9c3d8f8e0f9f296 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#ab6f5262d41b6c96ef9c3d8f8e0f9f296">serialise_results</a> () const</td></tr>
<tr class="memdesc:ab6f5262d41b6c96ef9c3d8f8e0f9f296 inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Serialise the results of this match spy. <a href="classXapian_1_1MatchSpy.html#ab6f5262d41b6c96ef9c3d8f8e0f9f296">More...</a><br /></td></tr>
<tr class="separator:ab6f5262d41b6c96ef9c3d8f8e0f9f296 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2325f227e120de96e59dd9aa1a6bbf2 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#ac2325f227e120de96e59dd9aa1a6bbf2">merge_results</a> (const std::string &serialised)</td></tr>
<tr class="memdesc:ac2325f227e120de96e59dd9aa1a6bbf2 inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Unserialise some results, and merge them into this matchspy. <a href="classXapian_1_1MatchSpy.html#ac2325f227e120de96e59dd9aa1a6bbf2">More...</a><br /></td></tr>
<tr class="separator:ac2325f227e120de96e59dd9aa1a6bbf2 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b9a70c4d8f53096b200ad7ea7e830e9 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#a0b9a70c4d8f53096b200ad7ea7e830e9">get_description</a> () const</td></tr>
<tr class="memdesc:a0b9a70c4d8f53096b200ad7ea7e830e9 inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="classXapian_1_1MatchSpy.html#a0b9a70c4d8f53096b200ad7ea7e830e9">More...</a><br /></td></tr>
<tr class="separator:a0b9a70c4d8f53096b200ad7ea7e830e9 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99eb373ed1e478793c276a310b7f05fe inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#a99eb373ed1e478793c276a310b7f05fe">release</a> ()</td></tr>
<tr class="memdesc:a99eb373ed1e478793c276a310b7f05fe inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1MatchSpy.html#a99eb373ed1e478793c276a310b7f05fe">More...</a><br /></td></tr>
<tr class="separator:a99eb373ed1e478793c276a310b7f05fe inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6dc251cb155d29fdaec6619e7f5cb0d3 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchSpy.html#a6dc251cb155d29fdaec6619e7f5cb0d3">release</a> () const</td></tr>
<tr class="memdesc:a6dc251cb155d29fdaec6619e7f5cb0d3 inherit pub_methods_classXapian_1_1MatchSpy"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1MatchSpy.html#a6dc251cb155d29fdaec6619e7f5cb0d3">More...</a><br /></td></tr>
<tr class="separator:a6dc251cb155d29fdaec6619e7f5cb0d3 inherit pub_methods_classXapian_1_1MatchSpy"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Class for counting the frequencies of values in the matching documents. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad4f298ec9a4f0bb58ae1ded83e4db46c" name="ad4f298ec9a4f0bb58ae1ded83e4db46c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4f298ec9a4f0bb58ae1ded83e4db46c">◆ </a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * Xapian::ValueCountMatchSpy::clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone the match spy. </p>
<p >The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be passed information about the results seen by the parent.</p>
<p >If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.</p>
<p >Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="https://trac.xapian.org/ticket/554#comment:1">https://trac.xapian.org/ticket/554#comment:1</a> </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1MatchSpy.html#aa09d7673ed421f8b16fa6d79db5ad205">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="a265b88f764f1462947233db9105a5d25" name="a265b88f764f1462947233db9105a5d25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a265b88f764f1462947233db9105a5d25">◆ </a></span>get_description()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::ValueCountMatchSpy::get_description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string describing this object. </p>
<p >This default implementation returns a generic answer, to avoid forcing those deriving their own <a class="el" href="classXapian_1_1MatchSpy.html" title="Abstract base class for match spies.">MatchSpy</a> subclasses from having to implement this (they may not care what <a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a265b88f764f1462947233db9105a5d25" title="Return a string describing this object.">get_description()</a> gives for their subclass). </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1MatchSpy.html#a0b9a70c4d8f53096b200ad7ea7e830e9">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="a532aa4b7592750ce833a4a8031666119" name="a532aa4b7592750ce833a4a8031666119"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a532aa4b7592750ce833a4a8031666119">◆ </a></span>merge_results()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Xapian::ValueCountMatchSpy::merge_results </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>serialised</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unserialise some results, and merge them into this matchspy. </p>
<p >The order in which results are merged should not be significant, since this order is not specified (and will vary depending on the speed of the search in each sub-database).</p>
<p >If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">serialised</td><td>A string containing the serialised results. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1MatchSpy.html#ac2325f227e120de96e59dd9aa1a6bbf2">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="aa2baaef80a28006a1ef935036bd9b8f5" name="aa2baaef80a28006a1ef935036bd9b8f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2baaef80a28006a1ef935036bd9b8f5">◆ </a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::ValueCountMatchSpy::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the name of this match spy. </p>
<p >This name is used by the remote backend. It is passed with the serialised parameters to the remote server so that it knows which class to create.</p>
<p >Return the full namespace-qualified name of your class here - if your class is called MyApp::FooMatchSpy, return "MyApp::FooMatchSpy" from this method.</p>
<p >If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>. </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1MatchSpy.html#a8bb708d4d564af2c21c36b9ed6ea868f">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="a4635086013fa8146d6f7e9176bdc1623" name="a4635086013fa8146d6f7e9176bdc1623"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4635086013fa8146d6f7e9176bdc1623">◆ </a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueCountMatchSpy::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> & </td>
<td class="paramname"><em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>wt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implementation of virtual operator(). </p>
<p >This implementation tallies values for a matching document.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">doc</td><td>The document to tally values for. </td></tr>
<tr><td class="paramname">wt</td><td>The weight of the document (ignored by this class). </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classXapian_1_1MatchSpy.html#a46228fa80cf68ce528d2023ab38b642a">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="a4bc38753f440c8da6ff719ae17b7d671" name="a4bc38753f440c8da6ff719ae17b7d671"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bc38753f440c8da6ff719ae17b7d671">◆ </a></span>serialise()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::ValueCountMatchSpy::serialise </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return this object's parameters serialised as a single string. </p>
<p >If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>. </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1MatchSpy.html#af9920929d6343a17a14885c4a2d2e3cb">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="a04260d9ea536a77f553d4e70f258d42f" name="a04260d9ea536a77f553d4e70f258d42f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04260d9ea536a77f553d4e70f258d42f">◆ </a></span>serialise_results()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::ValueCountMatchSpy::serialise_results </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialise the results of this match spy. </p>
<p >If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>. </p>
<p>Reimplemented from <a class="el" href="classXapian_1_1MatchSpy.html#ab6f5262d41b6c96ef9c3d8f8e0f9f296">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="a84b4fadce263dbbaf80338969286248d" name="a84b4fadce263dbbaf80338969286248d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84b4fadce263dbbaf80338969286248d">◆ </a></span>top_values_begin()</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::ValueCountMatchSpy::top_values_begin </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>maxvalues</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator over the most frequent values seen in the slot. </p>
<p >Items will be returned in descending order of frequency. Values with the same frequency will be returned in ascending alphabetical order.</p>
<p >During the iteration, the frequency of the current value can be obtained with the get_termfreq() method on the iterator.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxvalues</td><td>The maximum number of values to return. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a71a6d28e5c39b6453678d502a72eb10e" name="a71a6d28e5c39b6453678d502a72eb10e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71a6d28e5c39b6453678d502a72eb10e">◆ </a></span>unserialise()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXapian_1_1MatchSpy.html">MatchSpy</a> * Xapian::ValueCountMatchSpy::unserialise </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>serialised</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Registry.html">Registry</a> & </td>
<td class="paramname"><em>context</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unserialise parameters. </p>
<p >This method unserialises parameters serialised by the <em><a class="el" href="classXapian_1_1ValueCountMatchSpy.html#a4bc38753f440c8da6ff719ae17b7d671" title="Return this object's parameters serialised as a single string.">serialise()</a></em> method and allocates and returns a new object initialised with them.</p>
<p >If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature.">Xapian::UnimplementedError</a>.</p>
<p >Note that the returned object will be deallocated by <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> API for use from another language) then you can define a static <code>operator delete</code> method in your subclass as shown here: <a href="https://trac.xapian.org/ticket/554#comment:1">https://trac.xapian.org/ticket/554#comment:1</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">serialised</td><td>A string containing the serialised results. </td></tr>
<tr><td class="paramname">context</td><td><a class="el" href="classXapian_1_1Registry.html" title="Registry for user subclasses.">Registry</a> object to use for unserialisation to permit <a class="el" href="classXapian_1_1MatchSpy.html" title="Abstract base class for match spies.">MatchSpy</a> subclasses with sub-MatchSpy objects to be implemented. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classXapian_1_1MatchSpy.html#a3e50f26f433edb87324e43e0af60aff4">Xapian::MatchSpy</a>.</p>
</div>
</div>
<a id="aebb501034b5d1f37f69eb2fcb793742b" name="aebb501034b5d1f37f69eb2fcb793742b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebb501034b5d1f37f69eb2fcb793742b">◆ </a></span>values_begin()</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::ValueCountMatchSpy::values_begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator over the values seen in the slot. </p>
<p >Items will be returned in ascending alphabetical order.</p>
<p >During the iteration, the frequency of the current value can be obtained with the get_termfreq() method on the iterator. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="matchspy_8h.html">matchspy.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.4</a>
</small></address>
</body>
</html>
|
