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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::Stem Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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_1Stem.html">Stem</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classXapian_1_1Stem-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::Stem Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class representing a stemming algorithm.
<a href="classXapian_1_1Stem.html#details">More...</a></p>
<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:a960dac1047a3cfe21ff3d013df1d41dd"><td class="memItemLeft" align="right" valign="top"><a id="a960dac1047a3cfe21ff3d013df1d41dd"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#a960dac1047a3cfe21ff3d013df1d41dd">Stem</a> (const <a class="el" href="classXapian_1_1Stem.html">Stem</a> &o)</td></tr>
<tr class="memdesc:a960dac1047a3cfe21ff3d013df1d41dd"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a960dac1047a3cfe21ff3d013df1d41dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9e8f12c49c8b3f62de1b8465298cf8c"><td class="memItemLeft" align="right" valign="top"><a id="ac9e8f12c49c8b3f62de1b8465298cf8c"></a>
<a class="el" href="classXapian_1_1Stem.html">Stem</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#ac9e8f12c49c8b3f62de1b8465298cf8c">operator=</a> (const <a class="el" href="classXapian_1_1Stem.html">Stem</a> &o)</td></tr>
<tr class="memdesc:ac9e8f12c49c8b3f62de1b8465298cf8c"><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <br /></td></tr>
<tr class="separator:ac9e8f12c49c8b3f62de1b8465298cf8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0119ddb5f571853900db97689bf9122d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#a0119ddb5f571853900db97689bf9122d">Stem</a> ()</td></tr>
<tr class="memdesc:a0119ddb5f571853900db97689bf9122d"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object which doesn't change terms. <a href="#a0119ddb5f571853900db97689bf9122d">More...</a><br /></td></tr>
<tr class="separator:a0119ddb5f571853900db97689bf9122d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c46cedf2047b159a7e4c9d4468242b1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#a6c46cedf2047b159a7e4c9d4468242b1">Stem</a> (const std::string &language)</td></tr>
<tr class="memdesc:a6c46cedf2047b159a7e4c9d4468242b1"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object for a particular language. <a href="#a6c46cedf2047b159a7e4c9d4468242b1">More...</a><br /></td></tr>
<tr class="separator:a6c46cedf2047b159a7e4c9d4468242b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abae2c707ea039fc519103ed75c7429fb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#abae2c707ea039fc519103ed75c7429fb">Stem</a> (<a class="el" href="classXapian_1_1StemImplementation.html">StemImplementation</a> *p)</td></tr>
<tr class="memdesc:abae2c707ea039fc519103ed75c7429fb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object with a user-provided stemming algorithm. <a href="#abae2c707ea039fc519103ed75c7429fb">More...</a><br /></td></tr>
<tr class="separator:abae2c707ea039fc519103ed75c7429fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4e246e78c5c947537e11c3f7e718eca"><td class="memItemLeft" align="right" valign="top"><a id="ac4e246e78c5c947537e11c3f7e718eca"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#ac4e246e78c5c947537e11c3f7e718eca">~Stem</a> ()</td></tr>
<tr class="memdesc:ac4e246e78c5c947537e11c3f7e718eca"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ac4e246e78c5c947537e11c3f7e718eca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd41894e249a0e69404c9ca8049d3dd2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#acd41894e249a0e69404c9ca8049d3dd2">operator()</a> (const std::string &word) const</td></tr>
<tr class="memdesc:acd41894e249a0e69404c9ca8049d3dd2"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Stem</a> a word. <a href="#acd41894e249a0e69404c9ca8049d3dd2">More...</a><br /></td></tr>
<tr class="separator:acd41894e249a0e69404c9ca8049d3dd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6956ebc4aca22a10abbf93b93d546e4"><td class="memItemLeft" align="right" valign="top"><a id="af6956ebc4aca22a10abbf93b93d546e4"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#af6956ebc4aca22a10abbf93b93d546e4">get_description</a> () const</td></tr>
<tr class="memdesc:af6956ebc4aca22a10abbf93b93d546e4"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:af6956ebc4aca22a10abbf93b93d546e4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0f8f250587dfef35d47f13f0ec0028fb"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#a0f8f250587dfef35d47f13f0ec0028fb">get_available_languages</a> ()</td></tr>
<tr class="memdesc:a0f8f250587dfef35d47f13f0ec0028fb"><td class="mdescLeft"> </td><td class="mdescRight">Return a list of available languages. <a href="#a0f8f250587dfef35d47f13f0ec0028fb">More...</a><br /></td></tr>
<tr class="separator:a0f8f250587dfef35d47f13f0ec0028fb"><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 representing a stemming algorithm. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a0119ddb5f571853900db97689bf9122d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0119ddb5f571853900db97689bf9122d">◆ </a></span>Stem() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::Stem::Stem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object which doesn't change terms. </p>
<p>Equivalent to <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Stem</a>("none"). </p>
</div>
</div>
<a id="a6c46cedf2047b159a7e4c9d4468242b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c46cedf2047b159a7e4c9d4468242b1">◆ </a></span>Stem() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::Stem::Stem </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>language</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object for a particular language. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">language</td><td>Either the English name for the language or the two letter ISO639 code.</td></tr>
</table>
</dd>
</dl>
<p>The following language names are understood (aliases follow the name):</p>
<ul>
<li>none - don't stem terms</li>
<li>armenian (hy)</li>
<li>basque (eu)</li>
<li>catalan (ca)</li>
<li>danish (da)</li>
<li>dutch (nl)</li>
<li>english (en) - Martin Porter's 2002 revision of his stemmer</li>
<li>earlyenglish - Early English (e.g. Shakespeare, Dickens) stemmer</li>
<li>english_lovins (lovins) - Lovin's stemmer</li>
<li>english_porter (porter) - Porter's stemmer as described in his 1980 paper</li>
<li>finnish (fi)</li>
<li>french (fr)</li>
<li>german (de)</li>
<li>german2 - Normalises umlauts and ß</li>
<li>hungarian (hu)</li>
<li>italian (it)</li>
<li>kraaij_pohlmann - A different Dutch stemmer</li>
<li>norwegian (nb, nn, no)</li>
<li>portuguese (pt)</li>
<li>romanian (ro)</li>
<li>russian (ru)</li>
<li>spanish (es)</li>
<li>swedish (sv)</li>
<li>turkish (tr)</li>
</ul>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API. ">Xapian::InvalidArgumentError</a></td><td>is thrown if language isn't recognised. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abae2c707ea039fc519103ed75c7429fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abae2c707ea039fc519103ed75c7429fb">◆ </a></span>Stem() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::Stem::Stem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1StemImplementation.html">StemImplementation</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object with a user-provided stemming algorithm. </p>
<p>You can subclass <a class="el" href="classXapian_1_1StemImplementation.html" title="Class representing a stemming algorithm implementation. ">Xapian::StemImplementation</a> to implement your own stemming algorithm (or to wrap a third-party algorithm) and then wrap your implementation in a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object to pass to the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> API.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The user-subclassed <a class="el" href="classXapian_1_1StemImplementation.html" title="Class representing a stemming algorithm implementation. ">StemImplementation</a> object. This is reference counted, and so will be automatically deleted by the <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> wrapper when no longer required. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0f8f250587dfef35d47f13f0ec0028fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f8f250587dfef35d47f13f0ec0028fb">◆ </a></span>get_available_languages()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string Xapian::Stem::get_available_languages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a list of available languages. </p>
<p>Each stemmer is only included once in the list (not once for each alias). The name included is the English name of the language.</p>
<p>The list is returned as a string, with language names separated by spaces. This is a static method, so a <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Xapian::Stem</a> object is not required for this operation. </p>
</div>
</div>
<a id="acd41894e249a0e69404c9ca8049d3dd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd41894e249a0e69404c9ca8049d3dd2">◆ </a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::Stem::operator() </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>word</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm. ">Stem</a> a word. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>a word to stem. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the stem </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="stem_8h.html">stem.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<address><small>
Documentation for Xapian (version 1.4.3).<br>
Generated on Wed Jan 25 2017 by
<a href="http://www.doxygen.org/">Doxygen 1.8.13</a>.
</small></address>
</body>
</html>
|
