Debian Codegraph @

docs/apidoc/html/classXapian_1_1SimpleStopper.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::SimpleStopper 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_1SimpleStopper.html">SimpleStopper</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_1SimpleStopper-members.html">List of all members</a> </div>
52 <div class="headertitle"><div class="title">Xapian::SimpleStopper Class Reference</div></div>
53 </div><!--header-->
54 <div class="contents">
55
56 <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.
57 <a href="#details">More...</a></p>
58
59 <p><code>#include &lt;queryparser.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::SimpleStopper:</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_1SimpleStopper__inherit__graph.png" border="0" usemap="#aXapian_1_1SimpleStopper_inherit__map" loading="lazy" alt="Inheritance graph"/></div>
65 <map name="aXapian_1_1SimpleStopper_inherit__map" id="aXapian_1_1SimpleStopper_inherit__map">
66 <area shape="rect" title="Simple implementation of Stopper class &#45; this will suit most users." alt="" coords="5,174,175,201"/>
67 <area shape="rect" href="classXapian_1_1Stopper.html" title="Abstract base class for stop&#45;word decision functor." alt="" coords="28,98,152,126"/>
68 <area shape="poly" title=" " alt="" coords="92,140,92,174,88,172,88,143"/>
69 <area shape="rect" title=" " alt="" coords="13,5,167,50"/>
70 <area shape="poly" title=" " alt="" coords="91,63,93,98,87,97,89,68"/>
71 </map>
72 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
73 <table class="memberdecls">
74 <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
75 Public Member Functions</h2></td></tr>
76 <tr class="memitem:a524d06efe68acee3358809108b5ad22e" id="r_a524d06efe68acee3358809108b5ad22e"><td class="memItemLeft" align="right" valign="top"><a id="a524d06efe68acee3358809108b5ad22e" name="a524d06efe68acee3358809108b5ad22e"></a>
77 &#160;</td><td class="memItemRight" valign="bottom"><b>SimpleStopper</b> ()</td></tr>
78 <tr class="memdesc:a524d06efe68acee3358809108b5ad22e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
79 <tr class="memitem:ab9a22e0bea880842d7e568ad97af8295" id="r_ab9a22e0bea880842d7e568ad97af8295"><td class="memTemplParams" colspan="2">template&lt;class Iterator&gt; </td></tr>
80 <tr class="memitem:ab9a22e0bea880842d7e568ad97af8295 template"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9a22e0bea880842d7e568ad97af8295">SimpleStopper</a> (Iterator begin, Iterator end)</td></tr>
81 <tr class="memdesc:ab9a22e0bea880842d7e568ad97af8295"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise from a pair of iterators. <br /></td></tr>
82 <tr class="memitem:a48b8ce2de81a61460911adc065ba8afb" id="r_a48b8ce2de81a61460911adc065ba8afb"><td class="memItemLeft" align="right" valign="top"><a id="a48b8ce2de81a61460911adc065ba8afb" name="a48b8ce2de81a61460911adc065ba8afb"></a>
83 void&#160;</td><td class="memItemRight" valign="bottom"><b>add</b> (const std::string &amp;word)</td></tr>
84 <tr class="memdesc:a48b8ce2de81a61460911adc065ba8afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a single stop word. <br /></td></tr>
85 <tr class="memitem:ae0e854c447e84622d68bc5b463e65667" id="r_ae0e854c447e84622d68bc5b463e65667"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0e854c447e84622d68bc5b463e65667">operator()</a> (const std::string &amp;term) const</td></tr>
86 <tr class="memdesc:ae0e854c447e84622d68bc5b463e65667"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is term a stop-word? <br /></td></tr>
87 <tr class="memitem:a6b46714e29740d723ccd950549820691" id="r_a6b46714e29740d723ccd950549820691"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b46714e29740d723ccd950549820691">get_description</a> () const</td></tr>
88 <tr class="memdesc:a6b46714e29740d723ccd950549820691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
89 <tr class="inherit_header pub_methods_classXapian_1_1Stopper"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classXapian_1_1Stopper')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classXapian_1_1Stopper.html">Xapian::Stopper</a></td></tr>
90 <tr class="memitem:a5e444dd3cab844607bfef909a7835168 inherit pub_methods_classXapian_1_1Stopper" id="r_a5e444dd3cab844607bfef909a7835168"><td class="memItemLeft" align="right" valign="top">
91 &#160;</td><td class="memItemRight" valign="bottom"><b>Stopper</b> ()</td></tr>
92 <tr class="memdesc:a5e444dd3cab844607bfef909a7835168 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
93 <tr class="memitem:ab7ae723a6b0a1866196b7ed139184208 inherit pub_methods_classXapian_1_1Stopper" id="r_ab7ae723a6b0a1866196b7ed139184208"><td class="memItemLeft" align="right" valign="top">
94 virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~Stopper</b> ()</td></tr>
95 <tr class="memdesc:ab7ae723a6b0a1866196b7ed139184208 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class has virtual methods, so provide a virtual destructor. <br /></td></tr>
96 <tr class="memitem:a61933e7a0b9660b71de9bbd65742ab00 inherit pub_methods_classXapian_1_1Stopper" id="r_a61933e7a0b9660b71de9bbd65742ab00"><td class="memItemLeft" align="right" valign="top">Stopper *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stopper.html#a61933e7a0b9660b71de9bbd65742ab00">release</a> ()</td></tr>
97 <tr class="memdesc:a61933e7a0b9660b71de9bbd65742ab00 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start reference counting this object. <br /></td></tr>
98 <tr class="memitem:a612e2e661d9c762650777aa47a63a075 inherit pub_methods_classXapian_1_1Stopper" id="r_a612e2e661d9c762650777aa47a63a075"><td class="memItemLeft" align="right" valign="top">const Stopper *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stopper.html#a612e2e661d9c762650777aa47a63a075">release</a> () const</td></tr>
99 <tr class="memdesc:a612e2e661d9c762650777aa47a63a075 inherit pub_methods_classXapian_1_1Stopper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start reference counting this object. <br /></td></tr>
100 </table>
101 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
102 <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>
103 </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
104 <a id="ab9a22e0bea880842d7e568ad97af8295" name="ab9a22e0bea880842d7e568ad97af8295"></a>
105 <h2 class="memtitle"><span class="permalink"><a href="#ab9a22e0bea880842d7e568ad97af8295">&#9670;&#160;</a></span>SimpleStopper()</h2>
106
107 <div class="memitem">
108 <div class="memproto">
109 <div class="memtemplate">
110 template&lt;class Iterator&gt; </div>
111 <table class="mlabels">
112 <tr>
113 <td class="mlabels-left">
114 <table class="memname">
115 <tr>
116 <td class="memname">Xapian::SimpleStopper::SimpleStopper </td>
117 <td>(</td>
118 <td class="paramtype">Iterator</td> <td class="paramname"><span class="paramname"><em>begin</em></span>, </td>
119 </tr>
120 <tr>
121 <td class="paramkey"></td>
122 <td></td>
123 <td class="paramtype">Iterator</td> <td class="paramname"><span class="paramname"><em>end</em></span>&#160;)</td>
124 </tr>
125 </table>
126 </td>
127 <td class="mlabels-right">
128 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
129 </tr>
130 </table>
131 </div><div class="memdoc">
132
133 <p>Initialise from a pair of iterators. </p>
134 <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">&quot;stopwords/english/stop.txt&quot;</span>);</div>
135 <div class="line">Xapian::SimplerStopper stopper(std::istream_iterator&lt;std::string&gt;(words), std::istream_iterator&lt;std::string&gt;());</div>
136 </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>
137
138 </div>
139 </div>
140 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
141 <a id="a6b46714e29740d723ccd950549820691" name="a6b46714e29740d723ccd950549820691"></a>
142 <h2 class="memtitle"><span class="permalink"><a href="#a6b46714e29740d723ccd950549820691">&#9670;&#160;</a></span>get_description()</h2>
143
144 <div class="memitem">
145 <div class="memproto">
146 <table class="mlabels">
147 <tr>
148 <td class="mlabels-left">
149 <table class="memname">
150 <tr>
151 <td class="memname">virtual std::string Xapian::SimpleStopper::get_description </td>
152 <td>(</td>
153 <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
154 <td> const</td>
155 </tr>
156 </table>
157 </td>
158 <td class="mlabels-right">
159 <span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
160 </tr>
161 </table>
162 </div><div class="memdoc">
163
164 <p>Return a string describing this object. </p>
165
166 <p>Reimplemented from <a class="el" href="classXapian_1_1Stopper.html#abf2702417e3805514ddc771de133378c">Xapian::Stopper</a>.</p>
167
168 </div>
169 </div>
170 <a id="ae0e854c447e84622d68bc5b463e65667" name="ae0e854c447e84622d68bc5b463e65667"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#ae0e854c447e84622d68bc5b463e65667">&#9670;&#160;</a></span>operator()()</h2>
172
173 <div class="memitem">
174 <div class="memproto">
175 <table class="mlabels">
176 <tr>
177 <td class="mlabels-left">
178 <table class="memname">
179 <tr>
180 <td class="memname">virtual bool Xapian::SimpleStopper::operator() </td>
181 <td>(</td>
182 <td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>term</em></span></td><td>)</td>
183 <td> const</td>
184 </tr>
185 </table>
186 </td>
187 <td class="mlabels-right">
188 <span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
189 </tr>
190 </table>
191 </div><div class="memdoc">
192
193 <p>Is term a stop-word? </p>
194 <dl class="params"><dt>Parameters</dt><dd>
195 <table class="params">
196 <tr><td class="paramname">term</td><td>The term to test. </td></tr>
197 </table>
198 </dd>
199 </dl>
200
201 <p>Implements <a class="el" href="classXapian_1_1Stopper.html#a28c9649a93987abb97d06998a146d6fe">Xapian::Stopper</a>.</p>
202
203 </div>
204 </div>
205 <hr/>The documentation for this class was generated from the following file:<ul>
206 <li>xapian/<a class="el" href="queryparser_8h.html">queryparser.h</a></li>
207 </ul>
208 </div><!-- contents -->
209 <!-- start footer part -->
210 <hr class="footer"/><address class="footer"><small>
211 Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a>
212 </small></address>
213 </body>
214 </html>