blob: 6e88ede809122fbbe09383c0e927b66295016c90 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.3"/>
<title>Lucene.Net: Lucene.Net.Analysis.Hunspell.HunspellStemmer 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis.html">Analysis</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis_1_1_hunspell.html">Hunspell</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html">HunspellStemmer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.Hunspell.HunspellStemmer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html" title="HunspellStemmer uses the affix rules declared in the HunspellDictionary to generate one or more stems...">HunspellStemmer</a> uses the affix rules declared in the <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> to generate one or more stems for a word. It conforms to the algorithm in the original hunspell algorithm, including recursive suffix stripping.
<a href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.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:a40480f43d093abbf24fb50dce538f91b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html#a40480f43d093abbf24fb50dce538f91b">HunspellStemmer</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> dictionary)</td></tr>
<tr class="memdesc:a40480f43d093abbf24fb50dce538f91b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html" title="HunspellStemmer uses the affix rules declared in the HunspellDictionary to generate one or more stems...">HunspellStemmer</a> which will use the provided <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> to create its stems. <a href="#a40480f43d093abbf24fb50dce538f91b"></a><br/></td></tr>
<tr class="separator:a40480f43d093abbf24fb50dce538f91b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e1205d074c2dcf0f31e77587d8584a6"><td class="memItemLeft" align="right" valign="top">IEnumerable&lt; <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stem.html">HunspellStem</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html#a3e1205d074c2dcf0f31e77587d8584a6">Stem</a> (String word)</td></tr>
<tr class="memdesc:a3e1205d074c2dcf0f31e77587d8584a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the stem(s) of the provided word. <a href="#a3e1205d074c2dcf0f31e77587d8584a6"></a><br/></td></tr>
<tr class="separator:a3e1205d074c2dcf0f31e77587d8584a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae482e8098f02343bae9cd37987db8bb"><td class="memItemLeft" align="right" valign="top">IEnumerable&lt; <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stem.html">HunspellStem</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html#aae482e8098f02343bae9cd37987db8bb">UniqueStems</a> (String word)</td></tr>
<tr class="memdesc:aae482e8098f02343bae9cd37987db8bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the unique stem(s) of the provided word. <a href="#aae482e8098f02343bae9cd37987db8bb"></a><br/></td></tr>
<tr class="separator:aae482e8098f02343bae9cd37987db8bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b5874e620f4467e73457e85bc786376"><td class="memItemLeft" align="right" valign="top">IEnumerable&lt; <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stem.html">HunspellStem</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html#a6b5874e620f4467e73457e85bc786376">ApplyAffix</a> (String strippedWord, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html">HunspellAffix</a> affix, Int32 recursionDepth)</td></tr>
<tr class="memdesc:a6b5874e620f4467e73457e85bc786376"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applies the affix rule to the given word, producing a list of stems if any are found. <a href="#a6b5874e620f4467e73457e85bc786376"></a><br/></td></tr>
<tr class="separator:a6b5874e620f4467e73457e85bc786376"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html" title="HunspellStemmer uses the affix rules declared in the HunspellDictionary to generate one or more stems...">HunspellStemmer</a> uses the affix rules declared in the <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> to generate one or more stems for a word. It conforms to the algorithm in the original hunspell algorithm, including recursive suffix stripping. </p>
<p>&lt;author&gt;Chris Male&lt;/author&gt; </p>
<p>Definition at line <a class="el" href="_hunspell_stemmer_8cs_source.html#l00030">30</a> of file <a class="el" href="_hunspell_stemmer_8cs_source.html">HunspellStemmer.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a40480f43d093abbf24fb50dce538f91b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Analysis.Hunspell.HunspellStemmer.HunspellStemmer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a>&#160;</td>
<td class="paramname"><em>dictionary</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stemmer.html" title="HunspellStemmer uses the affix rules declared in the HunspellDictionary to generate one or more stems...">HunspellStemmer</a> which will use the provided <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> to create its stems. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dictionary</td><td><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> that will be used to create the stems.</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_hunspell_stemmer_8cs_source.html#l00039">39</a> of file <a class="el" href="_hunspell_stemmer_8cs_source.html">HunspellStemmer.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6b5874e620f4467e73457e85bc786376"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerable&lt;<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stem.html">HunspellStem</a>&gt; Lucene.Net.Analysis.Hunspell.HunspellStemmer.ApplyAffix </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>strippedWord</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html">HunspellAffix</a>&#160;</td>
<td class="paramname"><em>affix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Int32&#160;</td>
<td class="paramname"><em>recursionDepth</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Applies the affix rule to the given word, producing a list of stems if any are found. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strippedWord</td><td>Word the affix has been removed and the strip added.</td></tr>
<tr><td class="paramname">affix</td><td><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html" title="Wrapper class representing a hunspell affix. ">HunspellAffix</a> representing the affix rule itself.</td></tr>
<tr><td class="paramname">recursionDepth</td><td>Level of recursion this stemming step is at.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>List of stems for the word, or an empty list if none are found.</dd></dl>
<p>Definition at line <a class="el" href="_hunspell_stemmer_8cs_source.html#l00158">158</a> of file <a class="el" href="_hunspell_stemmer_8cs_source.html">HunspellStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a3e1205d074c2dcf0f31e77587d8584a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerable&lt;<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stem.html">HunspellStem</a>&gt; Lucene.Net.Analysis.Hunspell.HunspellStemmer.Stem </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>word</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the stem(s) of the provided word. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>Word to find the stems for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>List of stems for the word.</dd></dl>
<p>Definition at line <a class="el" href="_hunspell_stemmer_8cs_source.html#l00049">49</a> of file <a class="el" href="_hunspell_stemmer_8cs_source.html">HunspellStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aae482e8098f02343bae9cd37987db8bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerable&lt;<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_stem.html">HunspellStem</a>&gt; Lucene.Net.Analysis.Hunspell.HunspellStemmer.UniqueStems </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>word</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the unique stem(s) of the provided word. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>Word to find the stems for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>List of stems for the word.</dd></dl>
<p>Definition at line <a class="el" href="_hunspell_stemmer_8cs_source.html#l00065">65</a> of file <a class="el" href="_hunspell_stemmer_8cs_source.html">HunspellStemmer.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Analyzers/Hunspell/<a class="el" href="_hunspell_stemmer_8cs_source.html">HunspellStemmer.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:48 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>