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
|
<!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::ValueSetMatchDecider 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_1ValueSetMatchDecider.html">ValueSetMatchDecider</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1ValueSetMatchDecider-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::ValueSetMatchDecider Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> filtering results based on whether document values are in a user-defined set.
<a href="classXapian_1_1ValueSetMatchDecider.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::ValueSetMatchDecider:</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_1ValueSetMatchDecider__inherit__graph.png" border="0" usemap="#aXapian_1_1ValueSetMatchDecider_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1ValueSetMatchDecider_inherit__map" id="aXapian_1_1ValueSetMatchDecider_inherit__map">
<area shape="rect" title="MatchDecider filtering results based on whether document values are in a user-defined set." alt="" coords="5,80,228,107"/>
<area shape="rect" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor." alt="" coords="34,5,199,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1f63ce5e07042150e324c754e3a98d09"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueSetMatchDecider.html#a1f63ce5e07042150e324c754e3a98d09">ValueSetMatchDecider</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot, bool inclusive_)</td></tr>
<tr class="memdesc:a1f63ce5e07042150e324c754e3a98d09"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1ValueSetMatchDecider.html" title="MatchDecider filtering results based on whether document values are in a user-defined set.">ValueSetMatchDecider</a>. <a href="classXapian_1_1ValueSetMatchDecider.html#a1f63ce5e07042150e324c754e3a98d09">More...</a><br /></td></tr>
<tr class="separator:a1f63ce5e07042150e324c754e3a98d09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7ea29abdfff5425ea6e75a318b1c961"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueSetMatchDecider.html#ac7ea29abdfff5425ea6e75a318b1c961">add_value</a> (const std::string &value)</td></tr>
<tr class="memdesc:ac7ea29abdfff5425ea6e75a318b1c961"><td class="mdescLeft"> </td><td class="mdescRight">Add a value to the test set. <a href="classXapian_1_1ValueSetMatchDecider.html#ac7ea29abdfff5425ea6e75a318b1c961">More...</a><br /></td></tr>
<tr class="separator:ac7ea29abdfff5425ea6e75a318b1c961"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ee026448fcb6501703949cf201f0487"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueSetMatchDecider.html#a2ee026448fcb6501703949cf201f0487">remove_value</a> (const std::string &value)</td></tr>
<tr class="memdesc:a2ee026448fcb6501703949cf201f0487"><td class="mdescLeft"> </td><td class="mdescRight">Remove a value from the test set. <a href="classXapian_1_1ValueSetMatchDecider.html#a2ee026448fcb6501703949cf201f0487">More...</a><br /></td></tr>
<tr class="separator:a2ee026448fcb6501703949cf201f0487"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a110d2d3b57631db3d89fcfd8f2abee31"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueSetMatchDecider.html#a110d2d3b57631db3d89fcfd8f2abee31">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &doc) const</td></tr>
<tr class="memdesc:a110d2d3b57631db3d89fcfd8f2abee31"><td class="mdescLeft"> </td><td class="mdescRight">Decide whether we want a particular document to be in the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>. <a href="classXapian_1_1ValueSetMatchDecider.html#a110d2d3b57631db3d89fcfd8f2abee31">More...</a><br /></td></tr>
<tr class="separator:a110d2d3b57631db3d89fcfd8f2abee31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1MatchDecider"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1MatchDecider')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1MatchDecider.html">Xapian::MatchDecider</a></td></tr>
<tr class="memitem:a22f4d1ac8861a3532c76a1eee651412e inherit pub_methods_classXapian_1_1MatchDecider"><td class="memItemLeft" align="right" valign="top"><a id="a22f4d1ac8861a3532c76a1eee651412e"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchDecider.html#a22f4d1ac8861a3532c76a1eee651412e">MatchDecider</a> ()</td></tr>
<tr class="memdesc:a22f4d1ac8861a3532c76a1eee651412e inherit pub_methods_classXapian_1_1MatchDecider"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a22f4d1ac8861a3532c76a1eee651412e inherit pub_methods_classXapian_1_1MatchDecider"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa102dbb2de58d3e96c684eb8e97520fc inherit pub_methods_classXapian_1_1MatchDecider"><td class="memItemLeft" align="right" valign="top"><a id="aa102dbb2de58d3e96c684eb8e97520fc"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1MatchDecider.html#aa102dbb2de58d3e96c684eb8e97520fc">~MatchDecider</a> ()</td></tr>
<tr class="memdesc:aa102dbb2de58d3e96c684eb8e97520fc inherit pub_methods_classXapian_1_1MatchDecider"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:aa102dbb2de58d3e96c684eb8e97520fc inherit pub_methods_classXapian_1_1MatchDecider"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor.">MatchDecider</a> filtering results based on whether document values are in a user-defined set. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a1f63ce5e07042150e324c754e3a98d09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f63ce5e07042150e324c754e3a98d09">◆ </a></span>ValueSetMatchDecider()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::ValueSetMatchDecider::ValueSetMatchDecider </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>slot</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>inclusive_</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1ValueSetMatchDecider.html" title="MatchDecider filtering results based on whether document values are in a user-defined set.">ValueSetMatchDecider</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot</td><td>The value slot number to look in.</td></tr>
<tr><td class="paramname">inclusive_</td><td>If true, match decider accepts documents which have a value in the specified slot which is a member of the test set; if false, match decider accepts documents which do not have a value in the specified slot. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac7ea29abdfff5425ea6e75a318b1c961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7ea29abdfff5425ea6e75a318b1c961">◆ </a></span>add_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueSetMatchDecider::add_value </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a value to the test set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to add to the test set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a110d2d3b57631db3d89fcfd8f2abee31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a110d2d3b57631db3d89fcfd8f2abee31">◆ </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">bool Xapian::ValueSetMatchDecider::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><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>Decide whether we want a particular document to be in the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">doc</td><td>The document to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the document is acceptable, or false if the document should be excluded from the <a class="el" href="classXapian_1_1MSet.html" title="Class representing a list of search results.">MSet</a>. </dd></dl>
<p>Implements <a class="el" href="classXapian_1_1MatchDecider.html#a1c3b5b4b318521132024cd80df0ff2c3">Xapian::MatchDecider</a>.</p>
</div>
</div>
<a id="a2ee026448fcb6501703949cf201f0487"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ee026448fcb6501703949cf201f0487">◆ </a></span>remove_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueSetMatchDecider::remove_value </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a value from the test set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to remove from the test set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="valuesetmatchdecider_8h.html">valuesetmatchdecider.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>
|
