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
|
<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::SimpleStopper 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.29</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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_1SimpleStopper.html">SimpleStopper</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1SimpleStopper-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::SimpleStopper Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Simple implementation of <a class="el" href="classXapian_1_1Stopper.html" title="Abstract base class for stop-word decision functor.">Stopper</a> class - this will suit most users.
<a href="classXapian_1_1SimpleStopper.html#details">More...</a></p>
<p><code>#include <queryparser.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::SimpleStopper:</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_1SimpleStopper__inherit__graph.png" border="0" usemap="#aXapian_1_1SimpleStopper_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1SimpleStopper_inherit__map" id="aXapian_1_1SimpleStopper_inherit__map">
<area shape="rect" title="Simple implementation of Stopper class - this will suit most users." alt="" coords="5,167,176,192"/>
<area shape="rect" href="classXapian_1_1Stopper.html" title="Abstract base class for stop-word decision functor." alt="" coords="28,93,153,119"/>
<area shape="poly" title=" " alt="" coords="93,132,93,167,88,167,88,132"/>
<area shape="rect" title=" " alt="" coords="13,5,168,45"/>
<area shape="poly" title=" " alt="" coords="93,59,93,93,88,93,88,59"/>
</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:a524d06efe68acee3358809108b5ad22e" id="r_a524d06efe68acee3358809108b5ad22e"><td class="memItemLeft" align="right" valign="top"><a id="a524d06efe68acee3358809108b5ad22e" name="a524d06efe68acee3358809108b5ad22e"></a>
 </td><td class="memItemRight" valign="bottom"><b>SimpleStopper</b> ()</td></tr>
<tr class="memdesc:a524d06efe68acee3358809108b5ad22e"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a524d06efe68acee3358809108b5ad22e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9a22e0bea880842d7e568ad97af8295" id="r_ab9a22e0bea880842d7e568ad97af8295"><td class="memTemplParams" colspan="2">template<class Iterator > </td></tr>
<tr class="memitem:ab9a22e0bea880842d7e568ad97af8295"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#ab9a22e0bea880842d7e568ad97af8295">SimpleStopper</a> (Iterator begin, Iterator end)</td></tr>
<tr class="memdesc:ab9a22e0bea880842d7e568ad97af8295"><td class="mdescLeft"> </td><td class="mdescRight">Initialise from a pair of iterators. <br /></td></tr>
<tr class="separator:ab9a22e0bea880842d7e568ad97af8295"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48b8ce2de81a61460911adc065ba8afb" id="r_a48b8ce2de81a61460911adc065ba8afb"><td class="memItemLeft" align="right" valign="top"><a id="a48b8ce2de81a61460911adc065ba8afb" name="a48b8ce2de81a61460911adc065ba8afb"></a>
void </td><td class="memItemRight" valign="bottom"><b>add</b> (const std::string &word)</td></tr>
<tr class="memdesc:a48b8ce2de81a61460911adc065ba8afb"><td class="mdescLeft"> </td><td class="mdescRight">Add a single stop word. <br /></td></tr>
<tr class="separator:a48b8ce2de81a61460911adc065ba8afb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0e854c447e84622d68bc5b463e65667" id="r_ae0e854c447e84622d68bc5b463e65667"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#ae0e854c447e84622d68bc5b463e65667">operator()</a> (const std::string &term) const</td></tr>
<tr class="memdesc:ae0e854c447e84622d68bc5b463e65667"><td class="mdescLeft"> </td><td class="mdescRight">Is term a stop-word? <br /></td></tr>
<tr class="separator:ae0e854c447e84622d68bc5b463e65667"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b46714e29740d723ccd950549820691" id="r_a6b46714e29740d723ccd950549820691"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1SimpleStopper.html#a6b46714e29740d723ccd950549820691">get_description</a> () const</td></tr>
<tr class="memdesc:a6b46714e29740d723ccd950549820691"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a6b46714e29740d723ccd950549820691"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1Stopper"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1Stopper')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1Stopper.html">Xapian::Stopper</a></td></tr>
<tr class="memitem:a5e444dd3cab844607bfef909a7835168 inherit pub_methods_classXapian_1_1Stopper" id="r_a5e444dd3cab844607bfef909a7835168"><td class="memItemLeft" align="right" valign="top">
 </td><td class="memItemRight" valign="bottom"><b>Stopper</b> ()</td></tr>
<tr class="memdesc:a5e444dd3cab844607bfef909a7835168 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a5e444dd3cab844607bfef909a7835168 inherit pub_methods_classXapian_1_1Stopper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7ae723a6b0a1866196b7ed139184208 inherit pub_methods_classXapian_1_1Stopper" id="r_ab7ae723a6b0a1866196b7ed139184208"><td class="memItemLeft" align="right" valign="top">
virtual </td><td class="memItemRight" valign="bottom"><b>~Stopper</b> ()</td></tr>
<tr class="memdesc:ab7ae723a6b0a1866196b7ed139184208 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft"> </td><td class="mdescRight">Class has virtual methods, so provide a virtual destructor. <br /></td></tr>
<tr class="separator:ab7ae723a6b0a1866196b7ed139184208 inherit pub_methods_classXapian_1_1Stopper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61933e7a0b9660b71de9bbd65742ab00 inherit pub_methods_classXapian_1_1Stopper" id="r_a61933e7a0b9660b71de9bbd65742ab00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Stopper.html">Stopper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stopper.html#a61933e7a0b9660b71de9bbd65742ab00">release</a> ()</td></tr>
<tr class="memdesc:a61933e7a0b9660b71de9bbd65742ab00 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <br /></td></tr>
<tr class="separator:a61933e7a0b9660b71de9bbd65742ab00 inherit pub_methods_classXapian_1_1Stopper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a612e2e661d9c762650777aa47a63a075 inherit pub_methods_classXapian_1_1Stopper" id="r_a612e2e661d9c762650777aa47a63a075"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1Stopper.html">Stopper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stopper.html#a612e2e661d9c762650777aa47a63a075">release</a> () const</td></tr>
<tr class="memdesc:a612e2e661d9c762650777aa47a63a075 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <br /></td></tr>
<tr class="separator:a612e2e661d9c762650777aa47a63a075 inherit pub_methods_classXapian_1_1Stopper"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple implementation of <a class="el" href="classXapian_1_1Stopper.html" title="Abstract base class for stop-word decision functor.">Stopper</a> class - this will suit most users. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab9a22e0bea880842d7e568ad97af8295" name="ab9a22e0bea880842d7e568ad97af8295"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9a22e0bea880842d7e568ad97af8295">◆ </a></span>SimpleStopper()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Iterator > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::SimpleStopper::SimpleStopper </td>
<td>(</td>
<td class="paramtype">Iterator </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Iterator </td>
<td class="paramname"><em>end</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>Initialise from a pair of iterators. </p>
<p><a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> includes stopword list files for many languages. You can initialise from a file like so: </p><div class="fragment"><div class="line">std::ifstream words(<span class="stringliteral">"stopwords/english/stop.txt"</span>);</div>
<div class="line">Xapian::SimplerStopper stopper(std::istream_iterator<std::string>(words), std::istream_iterator<std::string>());</div>
</div><!-- fragment --><p>In bindings for other languages it isn't possible to pass a C++ iterator pair, so instead this constructor is wrapped to allow passing a filename. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6b46714e29740d723ccd950549820691" name="a6b46714e29740d723ccd950549820691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b46714e29740d723ccd950549820691">◆ </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::SimpleStopper::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>Reimplemented from <a class="el" href="classXapian_1_1Stopper.html#abf2702417e3805514ddc771de133378c">Xapian::Stopper</a>.</p>
</div>
</div>
<a id="ae0e854c447e84622d68bc5b463e65667" name="ae0e854c447e84622d68bc5b463e65667"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0e854c447e84622d68bc5b463e65667">◆ </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">virtual bool Xapian::SimpleStopper::operator() </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>term</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is term a stop-word? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to test. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classXapian_1_1Stopper.html#a28c9649a93987abb97d06998a146d6fe">Xapian::Stopper</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="queryparser_8h.html">queryparser.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.8</a>
</small></address>
</body>
</html>
|
