Debian Codegraph @

docs/apidoc/html/classXapian_1_1ValueSetMatchDecider.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.15.0"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Xapian: API Documentation: Xapian::ValueSetMatchDecider Class Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18 <tbody>
19 <tr style="height: 56px;">
20 <td id="projectalign" style="padding-left: 0.5em;">
21 <div id="projectname">xapian-core
22 &#160;<span id="projectnumber">1.4.31</span>
23 </div>
24 </td>
25 </tr>
26 </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.15.0 -->
31 <script type="text/javascript">
32 $(function() { codefold.init(); });
33 </script>
34 <script type="text/javascript" src="menudata.js"></script>
35 <script type="text/javascript" src="menu.js"></script>
36 <script type="text/javascript">
37 $(function() {
38 initMenu('',false,false,'search.php','Search',false);
39 });
40 </script>
41 <div id="main-nav"></div>
42 <div id="nav-path" class="navpath">
43 <ul>
44 <li class="navelem"><a href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a href="classXapian_1_1ValueSetMatchDecider.html">ValueSetMatchDecider</a></li> </ul>
45 </div>
46 </div><!-- top -->
47 <div id="doc-content">
48 <div class="header">
49 <div class="summary">
50 <a href="#pub-methods">Public Member Functions</a> &#124;
51 <a href="classXapian_1_1ValueSetMatchDecider-members.html">List of all members</a> </div>
52 <div class="headertitle"><div class="title">Xapian::ValueSetMatchDecider Class Reference</div></div>
53 </div><!--header-->
54 <div class="contents">
55
56 <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.
57 <a href="#details">More...</a></p>
58
59 <p><code>#include &lt;valuesetmatchdecider.h&gt;</code></p>
60 <div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for Xapian::ValueSetMatchDecider:</div>
61 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
62 </div>
63 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
64 <div class="center"><img src="classXapian_1_1ValueSetMatchDecider__inherit__graph.png" border="0" usemap="#aXapian_1_1ValueSetMatchDecider_inherit__map" loading="lazy" alt="Inheritance graph"/></div>
65 <map name="aXapian_1_1ValueSetMatchDecider_inherit__map" id="aXapian_1_1ValueSetMatchDecider_inherit__map">
66 <area shape="rect" title="MatchDecider filtering results based on whether document values are in a user&#45;defined set." alt="" coords="5,81,228,109"/>
67 <area shape="rect" href="classXapian_1_1MatchDecider.html" title="Base class for matcher decision functor." alt="" coords="34,5,199,33"/>
68 <area shape="poly" title=" " alt="" coords="118,47,119,82,114,79,115,51"/>
69 </map>
70 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
71 <table class="memberdecls">
72 <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
73 Public Member Functions</h2></td></tr>
74 <tr class="memitem:a1f63ce5e07042150e324c754e3a98d09" id="r_a1f63ce5e07042150e324c754e3a98d09"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f63ce5e07042150e324c754e3a98d09">ValueSetMatchDecider</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot, bool inclusive_)</td></tr>
75 <tr class="memdesc:a1f63ce5e07042150e324c754e3a98d09"><td class="mdescLeft">&#160;</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>. <br /></td></tr>
76 <tr class="memitem:ac7ea29abdfff5425ea6e75a318b1c961" id="r_ac7ea29abdfff5425ea6e75a318b1c961"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7ea29abdfff5425ea6e75a318b1c961">add_value</a> (const std::string &amp;value)</td></tr>
77 <tr class="memdesc:ac7ea29abdfff5425ea6e75a318b1c961"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a value to the test set. <br /></td></tr>
78 <tr class="memitem:a2ee026448fcb6501703949cf201f0487" id="r_a2ee026448fcb6501703949cf201f0487"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2ee026448fcb6501703949cf201f0487">remove_value</a> (const std::string &amp;value)</td></tr>
79 <tr class="memdesc:a2ee026448fcb6501703949cf201f0487"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a value from the test set. <br /></td></tr>
80 <tr class="memitem:a110d2d3b57631db3d89fcfd8f2abee31" id="r_a110d2d3b57631db3d89fcfd8f2abee31"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a110d2d3b57631db3d89fcfd8f2abee31">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &amp;doc) const</td></tr>
81 <tr class="memdesc:a110d2d3b57631db3d89fcfd8f2abee31"><td class="mdescLeft">&#160;</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>. <br /></td></tr>
82 <tr class="inherit_header pub_methods_classXapian_1_1MatchDecider"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classXapian_1_1MatchDecider')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classXapian_1_1MatchDecider.html">Xapian::MatchDecider</a></td></tr>
83 <tr class="memitem:a22f4d1ac8861a3532c76a1eee651412e inherit pub_methods_classXapian_1_1MatchDecider" id="r_a22f4d1ac8861a3532c76a1eee651412e"><td class="memItemLeft" align="right" valign="top">
84 &#160;</td><td class="memItemRight" valign="bottom"><b>MatchDecider</b> ()</td></tr>
85 <tr class="memdesc:a22f4d1ac8861a3532c76a1eee651412e inherit pub_methods_classXapian_1_1MatchDecider"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
86 <tr class="memitem:aa102dbb2de58d3e96c684eb8e97520fc inherit pub_methods_classXapian_1_1MatchDecider" id="r_aa102dbb2de58d3e96c684eb8e97520fc"><td class="memItemLeft" align="right" valign="top">
87 virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~MatchDecider</b> ()</td></tr>
88 <tr class="memdesc:aa102dbb2de58d3e96c684eb8e97520fc inherit pub_methods_classXapian_1_1MatchDecider"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
89 </table>
90 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
91 <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>
92 </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
93 <a id="a1f63ce5e07042150e324c754e3a98d09" name="a1f63ce5e07042150e324c754e3a98d09"></a>
94 <h2 class="memtitle"><span class="permalink"><a href="#a1f63ce5e07042150e324c754e3a98d09">&#9670;&#160;</a></span>ValueSetMatchDecider()</h2>
95
96 <div class="memitem">
97 <div class="memproto">
98 <table class="mlabels">
99 <tr>
100 <td class="mlabels-left">
101 <table class="memname">
102 <tr>
103 <td class="memname">Xapian::ValueSetMatchDecider::ValueSetMatchDecider </td>
104 <td>(</td>
105 <td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a></td> <td class="paramname"><span class="paramname"><em>slot</em></span>, </td>
106 </tr>
107 <tr>
108 <td class="paramkey"></td>
109 <td></td>
110 <td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>inclusive_</em></span>&#160;)</td>
111 </tr>
112 </table>
113 </td>
114 <td class="mlabels-right">
115 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
116 </tr>
117 </table>
118 </div><div class="memdoc">
119
120 <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>
121 <dl class="params"><dt>Parameters</dt><dd>
122 <table class="params">
123 <tr><td class="paramname">slot</td><td>The value slot number to look in.</td></tr>
124 <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>
125 </table>
126 </dd>
127 </dl>
128
129 </div>
130 </div>
131 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
132 <a id="ac7ea29abdfff5425ea6e75a318b1c961" name="ac7ea29abdfff5425ea6e75a318b1c961"></a>
133 <h2 class="memtitle"><span class="permalink"><a href="#ac7ea29abdfff5425ea6e75a318b1c961">&#9670;&#160;</a></span>add_value()</h2>
134
135 <div class="memitem">
136 <div class="memproto">
137 <table class="mlabels">
138 <tr>
139 <td class="mlabels-left">
140 <table class="memname">
141 <tr>
142 <td class="memname">void Xapian::ValueSetMatchDecider::add_value </td>
143 <td>(</td>
144 <td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
145 <td></td>
146 </tr>
147 </table>
148 </td>
149 <td class="mlabels-right">
150 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
151 </tr>
152 </table>
153 </div><div class="memdoc">
154
155 <p>Add a value to the test set. </p>
156 <dl class="params"><dt>Parameters</dt><dd>
157 <table class="params">
158 <tr><td class="paramname">value</td><td>The value to add to the test set. </td></tr>
159 </table>
160 </dd>
161 </dl>
162
163 </div>
164 </div>
165 <a id="a110d2d3b57631db3d89fcfd8f2abee31" name="a110d2d3b57631db3d89fcfd8f2abee31"></a>
166 <h2 class="memtitle"><span class="permalink"><a href="#a110d2d3b57631db3d89fcfd8f2abee31">&#9670;&#160;</a></span>operator()()</h2>
167
168 <div class="memitem">
169 <div class="memproto">
170 <table class="mlabels">
171 <tr>
172 <td class="mlabels-left">
173 <table class="memname">
174 <tr>
175 <td class="memname">bool Xapian::ValueSetMatchDecider::operator() </td>
176 <td>(</td>
177 <td class="paramtype">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &amp;</td> <td class="paramname"><span class="paramname"><em>doc</em></span></td><td>)</td>
178 <td> const</td>
179 </tr>
180 </table>
181 </td>
182 <td class="mlabels-right">
183 <span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
184 </tr>
185 </table>
186 </div><div class="memdoc">
187
188 <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>
189 <dl class="params"><dt>Parameters</dt><dd>
190 <table class="params">
191 <tr><td class="paramname">doc</td><td>The document to test. </td></tr>
192 </table>
193 </dd>
194 </dl>
195 <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>
196
197 <p>Implements <a class="el" href="classXapian_1_1MatchDecider.html#a1c3b5b4b318521132024cd80df0ff2c3">Xapian::MatchDecider</a>.</p>
198
199 </div>
200 </div>
201 <a id="a2ee026448fcb6501703949cf201f0487" name="a2ee026448fcb6501703949cf201f0487"></a>
202 <h2 class="memtitle"><span class="permalink"><a href="#a2ee026448fcb6501703949cf201f0487">&#9670;&#160;</a></span>remove_value()</h2>
203
204 <div class="memitem">
205 <div class="memproto">
206 <table class="mlabels">
207 <tr>
208 <td class="mlabels-left">
209 <table class="memname">
210 <tr>
211 <td class="memname">void Xapian::ValueSetMatchDecider::remove_value </td>
212 <td>(</td>
213 <td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
214 <td></td>
215 </tr>
216 </table>
217 </td>
218 <td class="mlabels-right">
219 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
220 </tr>
221 </table>
222 </div><div class="memdoc">
223
224 <p>Remove a value from the test set. </p>
225 <dl class="params"><dt>Parameters</dt><dd>
226 <table class="params">
227 <tr><td class="paramname">value</td><td>The value to remove from the test set. </td></tr>
228 </table>
229 </dd>
230 </dl>
231
232 </div>
233 </div>
234 <hr/>The documentation for this class was generated from the following file:<ul>
235 <li>xapian/<a class="el" href="valuesetmatchdecider_8h.html">valuesetmatchdecider.h</a></li>
236 </ul>
237 </div><!-- contents -->
238 <!-- start footer part -->
239 <hr class="footer"/><address class="footer"><small>
240 Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a>
241 </small></address>
242 </body>
243 </html>