<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: 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.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1Stem.html">Stem</a></div>
<h1>Xapian::Stem Class Reference</h1><!-- doxytag: class="Xapian::Stem" -->Class representing a stemming algorithm.
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1Stem-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#39d6c9f0e70f75c47855aacdb1bb264d">Stem</a> (const <a class="el" href="classXapian_1_1Stem.html">Stem</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#39d6c9f0e70f75c47855aacdb1bb264d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#ccc9fdb295db0bffb23bdbd385ded29b">operator=</a> (const <a class="el" href="classXapian_1_1Stem.html">Stem</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <a href="#ccc9fdb295db0bffb23bdbd385ded29b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#53aa0b2888c506686ef8fbbac2baf43e">Stem</a> ()</td></tr>
<tr><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="#53aa0b2888c506686ef8fbbac2baf43e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#d4adbe1617ce7c54c3aa7d3d67d407bd">Stem</a> (const std::string &language)</td></tr>
<tr><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="#d4adbe1617ce7c54c3aa7d3d67d407bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#9fcfcf45dbe49100ee7ca02cf9fc98bd">~Stem</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#9fcfcf45dbe49100ee7ca02cf9fc98bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#e4b7a74ac5bd468beb4e6c55d776fba0">operator()</a> (const std::string &word) const </td></tr>
<tr><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="#e4b7a74ac5bd468beb4e6c55d776fba0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#724586ac862ad4091c0556350037994f">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#724586ac862ad4091c0556350037994f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Stem.html#957574234cc1cfad8b051eed32ca4671">get_available_languages</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a list of available languages. <a href="#957574234cc1cfad8b051eed32ca4671"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class representing a stemming algorithm.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="39d6c9f0e70f75c47855aacdb1bb264d"></a><!-- doxytag: member="Xapian::Stem::Stem" ref="39d6c9f0e70f75c47855aacdb1bb264d" args="(const Stem &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::Stem::Stem </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Stem.html">Stem</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
</div>
</div><p>
<a class="anchor" name="53aa0b2888c506686ef8fbbac2baf43e"></a><!-- doxytag: member="Xapian::Stem::Stem" ref="53aa0b2888c506686ef8fbbac2baf43e" args="()" -->
<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 width="100%"></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>
Equivalent to <a class="el" href="classXapian_1_1Stem.html" title="Class representing a stemming algorithm.">Stem</a>("none").
</div>
</div><p>
<a class="anchor" name="d4adbe1617ce7c54c3aa7d3d67d407bd"></a><!-- doxytag: member="Xapian::Stem::Stem" ref="d4adbe1617ce7c54c3aa7d3d67d407bd" args="(const std::string &language)" -->
<div class="memitem">
<div class="memproto">
<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 width="100%"><code> [explicit]</code></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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>Either the English name for the language or the two letter ISO639 code.</td></tr>
</table>
</dl>
The following language names are understood (aliases follow the name):<p>
<ul>
<li>none - don't stem terms</li><li>danish (da)</li><li>dutch (nl)</li><li>english (en) - Martin Porter's 2002 revision of his 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>
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">Xapian::InvalidArgumentError</a></em> </td><td>is thrown if language isn't recognised. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9fcfcf45dbe49100ee7ca02cf9fc98bd"></a><!-- doxytag: member="Xapian::Stem::~Stem" ref="9fcfcf45dbe49100ee7ca02cf9fc98bd" args="()" -->
<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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ccc9fdb295db0bffb23bdbd385ded29b"></a><!-- doxytag: member="Xapian::Stem::operator=" ref="ccc9fdb295db0bffb23bdbd385ded29b" args="(const Stem &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Stem::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Stem.html">Stem</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment.
<p>
</div>
</div><p>
<a class="anchor" name="e4b7a74ac5bd468beb4e6c55d776fba0"></a><!-- doxytag: member="Xapian::Stem::operator()" ref="e4b7a74ac5bd468beb4e6c55d776fba0" args="(const std::string &word) const " -->
<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 width="100%"> 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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>word</em> </td><td>a word to stem. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the stem </dd></dl>
</div>
</div><p>
<a class="anchor" name="724586ac862ad4091c0556350037994f"></a><!-- doxytag: member="Xapian::Stem::get_description" ref="724586ac862ad4091c0556350037994f" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::Stem::get_description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string describing this object.
<p>
</div>
</div><p>
<a class="anchor" name="957574234cc1cfad8b051eed32ca4671"></a><!-- doxytag: member="Xapian::Stem::get_available_languages" ref="957574234cc1cfad8b051eed32ca4671" args="()" -->
<div class="memitem">
<div class="memproto">
<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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a list of available languages.
<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>
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.
</div>
</div><p>
<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></ul>
<hr>
<address><small>
Documentation for Xapian (version 1.0.21).<br>
Generated on 18 Jun 2010 by
<a href="http://www.doxygen.org/">Doxygen 1.5.2</a>.
</small></address>
</body>
</html>
