blob: 88c5500a26794d1242e3bb3e49ebdaab91e81113 [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.PorterStemmer 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="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html">PorterStemmer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.PorterStemmer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Stemmer, implementing the Porter Stemming Algorithm
<a href="class_lucene_1_1_net_1_1_analysis_1_1_porter_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:a8b7e05941a27a59f63d6df4836fdf183"><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_porter_stemmer.html#a8b7e05941a27a59f63d6df4836fdf183">PorterStemmer</a> ()</td></tr>
<tr class="separator:a8b7e05941a27a59f63d6df4836fdf183"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6480b229b615056cb655baf821b99cf2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a6480b229b615056cb655baf821b99cf2">Reset</a> ()</td></tr>
<tr class="memdesc:a6480b229b615056cb655baf821b99cf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">reset() resets the stemmer so it can stem another word. If you invoke the stemmer by calling add(char) and then stem(), you must call reset() before starting another word. <a href="#a6480b229b615056cb655baf821b99cf2"></a><br/></td></tr>
<tr class="separator:a6480b229b615056cb655baf821b99cf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ff9c141b2542c4525a28dae820c626c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a2ff9c141b2542c4525a28dae820c626c">Add</a> (char ch)</td></tr>
<tr class="memdesc:a2ff9c141b2542c4525a28dae820c626c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a character to the word being stemmed. When you are finished adding characters, you can call stem(void) to process the word. <a href="#a2ff9c141b2542c4525a28dae820c626c"></a><br/></td></tr>
<tr class="separator:a2ff9c141b2542c4525a28dae820c626c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af18edae9be6a09d700f6e863519d516f"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#af18edae9be6a09d700f6e863519d516f">ToString</a> ()</td></tr>
<tr class="memdesc:af18edae9be6a09d700f6e863519d516f"><td class="mdescLeft">&#160;</td><td class="mdescRight">After a word has been stemmed, it can be retrieved by toString(), or a reference to the internal buffer can be retrieved by getResultBuffer and getResultLength (which is generally more efficient.) <a href="#af18edae9be6a09d700f6e863519d516f"></a><br/></td></tr>
<tr class="separator:af18edae9be6a09d700f6e863519d516f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a861bd724c87fd7498487337b6521bfa6"><td class="memItemLeft" align="right" valign="top">virtual System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a861bd724c87fd7498487337b6521bfa6">Stem</a> (System.String s)</td></tr>
<tr class="memdesc:a861bd724c87fd7498487337b6521bfa6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stem a word provided as a String. Returns the result as a String. <a href="#a861bd724c87fd7498487337b6521bfa6"></a><br/></td></tr>
<tr class="separator:a861bd724c87fd7498487337b6521bfa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33ca5885adf8abb7604ed894f1dda0b5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a33ca5885adf8abb7604ed894f1dda0b5">Stem</a> (char[] word)</td></tr>
<tr class="memdesc:a33ca5885adf8abb7604ed894f1dda0b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stem a word contained in a char[]. Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). <a href="#a33ca5885adf8abb7604ed894f1dda0b5"></a><br/></td></tr>
<tr class="separator:a33ca5885adf8abb7604ed894f1dda0b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07d3afeef7825c779e1d1b20986a1e6d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a07d3afeef7825c779e1d1b20986a1e6d">Stem</a> (char[] wordBuffer, int offset, int wordLen)</td></tr>
<tr class="memdesc:a07d3afeef7825c779e1d1b20986a1e6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stem a word contained in a portion of a char[] array. Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). <a href="#a07d3afeef7825c779e1d1b20986a1e6d"></a><br/></td></tr>
<tr class="separator:a07d3afeef7825c779e1d1b20986a1e6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a115d25e022aef678d305b945ac946c3c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a115d25e022aef678d305b945ac946c3c">Stem</a> (char[] word, int wordLen)</td></tr>
<tr class="memdesc:a115d25e022aef678d305b945ac946c3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stem a word contained in a leading portion of a char[] array. Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). <a href="#a115d25e022aef678d305b945ac946c3c"></a><br/></td></tr>
<tr class="separator:a115d25e022aef678d305b945ac946c3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70ca26e044582968fe68d5bb8ec995aa"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a70ca26e044582968fe68d5bb8ec995aa">Stem</a> ()</td></tr>
<tr class="memdesc:a70ca26e044582968fe68d5bb8ec995aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stem the word placed into the Stemmer buffer through calls to add(). Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). <a href="#a70ca26e044582968fe68d5bb8ec995aa"></a><br/></td></tr>
<tr class="separator:a70ca26e044582968fe68d5bb8ec995aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d9d9e9de971d6b39bef0c69dc54f2e2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a4d9d9e9de971d6b39bef0c69dc54f2e2">Stem</a> (int i0)</td></tr>
<tr class="separator:a4d9d9e9de971d6b39bef0c69dc54f2e2"><td class="memSeparator" colspan="2">&#160;</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:aec31db8a4e1d7d82289d50d162faaf23"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#aec31db8a4e1d7d82289d50d162faaf23">Main</a> (System.String[] args)</td></tr>
<tr class="memdesc:aec31db8a4e1d7d82289d50d162faaf23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test program for demonstrating the Stemmer. It reads a file and stems each word, writing the result to standard out. Usage: Stemmer file-name <a href="#aec31db8a4e1d7d82289d50d162faaf23"></a><br/></td></tr>
<tr class="separator:aec31db8a4e1d7d82289d50d162faaf23"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a18f1b95d7d31446151be7bc7d3b31f16"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#a18f1b95d7d31446151be7bc7d3b31f16">ResultLength</a><code> [get]</code></td></tr>
<tr class="memdesc:a18f1b95d7d31446151be7bc7d3b31f16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the length of the word resulting from the stemming process. <a href="#a18f1b95d7d31446151be7bc7d3b31f16"></a><br/></td></tr>
<tr class="separator:a18f1b95d7d31446151be7bc7d3b31f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6c123720fd33309f3ee1c2b94131297"><td class="memItemLeft" align="right" valign="top">virtual char[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_porter_stemmer.html#ac6c123720fd33309f3ee1c2b94131297">ResultBuffer</a><code> [get]</code></td></tr>
<tr class="memdesc:ac6c123720fd33309f3ee1c2b94131297"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to a character buffer containing the results of the stemming process. You also need to consult getResultLength() to determine the length of the result. <a href="#ac6c123720fd33309f3ee1c2b94131297"></a><br/></td></tr>
<tr class="separator:ac6c123720fd33309f3ee1c2b94131297"><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>Stemmer, implementing the Porter Stemming Algorithm </p>
<p>The Stemmer class transforms a word into its root form. The input word can be provided a character at time (by calling add()), or at once by calling one of the various stem(something) methods. </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00054">54</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8b7e05941a27a59f63d6df4836fdf183"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Analysis.PorterStemmer.PorterStemmer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00062">62</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2ff9c141b2542c4525a28dae820c626c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Analysis.PorterStemmer.Add </td>
<td>(</td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>ch</em></td><td>)</td>
<td></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>Add a character to the word being stemmed. When you are finished adding characters, you can call stem(void) to process the word. </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00080">80</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aec31db8a4e1d7d82289d50d162faaf23"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void Lucene.Net.Analysis.PorterStemmer.Main </td>
<td>(</td>
<td class="paramtype">System.String[]&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Test program for demonstrating the Stemmer. It reads a file and stems each word, writing the result to standard out. Usage: Stemmer file-name </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00689">689</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6480b229b615056cb655baf821b99cf2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Analysis.PorterStemmer.Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>reset() resets the stemmer so it can stem another word. If you invoke the stemmer by calling add(char) and then stem(), you must call reset() before starting another word. </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00072">72</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a861bd724c87fd7498487337b6521bfa6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual System.String Lucene.Net.Analysis.PorterStemmer.Stem </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></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>Stem a word provided as a String. Returns the result as a String.</p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00611">611</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a33ca5885adf8abb7604ed894f1dda0b5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Analysis.PorterStemmer.Stem </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>word</em></td><td>)</td>
<td></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>Stem a word contained in a char[]. Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00625">625</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a07d3afeef7825c779e1d1b20986a1e6d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Analysis.PorterStemmer.Stem </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>wordBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>wordLen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>Stem a word contained in a portion of a char[] array. Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00635">635</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a115d25e022aef678d305b945ac946c3c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Analysis.PorterStemmer.Stem </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>word</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>wordLen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>Stem a word contained in a leading portion of a char[] array. Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00653">653</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a70ca26e044582968fe68d5bb8ec995aa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Analysis.PorterStemmer.Stem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Stem the word placed into the Stemmer buffer through calls to add(). Returns true if the stemming process resulted in a word different from the input. You can retrieve the result with getResultLength()/getResultBuffer() or toString(). </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00663">663</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4d9d9e9de971d6b39bef0c69dc54f2e2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Analysis.PorterStemmer.Stem </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i0</em></td><td>)</td>
<td></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>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00668">668</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af18edae9be6a09d700f6e863519d516f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Analysis.PorterStemmer.ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>After a word has been stemmed, it can be retrieved by toString(), or a reference to the internal buffer can be retrieved by getResultBuffer and getResultLength (which is generally more efficient.) </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00095">95</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ac6c123720fd33309f3ee1c2b94131297"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual char [] Lucene.Net.Analysis.PorterStemmer.ResultBuffer</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to a character buffer containing the results of the stemming process. You also need to consult getResultLength() to determine the length of the result. </p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00111">111</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a18f1b95d7d31446151be7bc7d3b31f16"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Lucene.Net.Analysis.PorterStemmer.ResultLength</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the length of the word resulting from the stemming process.</p>
<p>Definition at line <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html#l00102">102</a> of file <a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Analysis/<a class="el" href="core_2_analysis_2_porter_stemmer_8cs_source.html">PorterStemmer.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>