Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html
blob: efaf80d24568f28323786be7b7ad1d1fcf46eb59 [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: SpellChecker.Net.Search.Spell.SuggestWord 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_spell_checker.html">SpellChecker</a></li><li class="navelem"><a class="el" href="namespace_spell_checker_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_spell_checker_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_spell_checker_1_1_net_1_1_search_1_1_spell.html">Spell</a></li><li class="navelem"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html">SuggestWord</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SpellChecker.Net.Search.Spell.SuggestWord Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html" title="SuggestWord Class, used in suggestSimilar method in SpellChecker class.">SuggestWord</a> Class, used in suggestSimilar method in <a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_spell_checker.html">SpellChecker</a> class.
<a href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.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:a88735c039cdb3ce554c52ae16dfca897"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html#a88735c039cdb3ce554c52ae16dfca897">CompareTo</a> (<a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html">SuggestWord</a> a)</td></tr>
<tr class="separator:a88735c039cdb3ce554c52ae16dfca897"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab1c53890e31ecdad1ef2bab5854dd773"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html#ab1c53890e31ecdad1ef2bab5854dd773">score</a></td></tr>
<tr class="memdesc:ab1c53890e31ecdad1ef2bab5854dd773"><td class="mdescLeft">&#160;</td><td class="mdescRight">the score of the word <a href="#ab1c53890e31ecdad1ef2bab5854dd773"></a><br/></td></tr>
<tr class="separator:ab1c53890e31ecdad1ef2bab5854dd773"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22ea01d1d6c66a7726720196092bcff1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html#a22ea01d1d6c66a7726720196092bcff1">freq</a></td></tr>
<tr class="memdesc:a22ea01d1d6c66a7726720196092bcff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The freq of the word <a href="#a22ea01d1d6c66a7726720196092bcff1"></a><br/></td></tr>
<tr class="separator:a22ea01d1d6c66a7726720196092bcff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5699593761a8fc1a3ca04fa709411bd2"><td class="memItemLeft" align="right" valign="top">System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html#a5699593761a8fc1a3ca04fa709411bd2">termString</a></td></tr>
<tr class="memdesc:a5699593761a8fc1a3ca04fa709411bd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">the suggested word <a href="#a5699593761a8fc1a3ca04fa709411bd2"></a><br/></td></tr>
<tr class="separator:a5699593761a8fc1a3ca04fa709411bd2"><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_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html" title="SuggestWord Class, used in suggestSimilar method in SpellChecker class.">SuggestWord</a> Class, used in suggestSimilar method in <a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_spell_checker.html">SpellChecker</a> class. </p>
<p>&lt;author&gt; Nicolas Maisonneuve &lt;/author&gt; </p>
<p>Definition at line <a class="el" href="_suggest_word_8cs_source.html#l00028">28</a> of file <a class="el" href="_suggest_word_8cs_source.html">SuggestWord.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a88735c039cdb3ce554c52ae16dfca897"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SpellChecker.Net.Search.Spell.SuggestWord.CompareTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_suggest_word.html">SuggestWord</a>&#160;</td>
<td class="paramname"><em>a</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_suggest_word_8cs_source.html#l00039">39</a> of file <a class="el" href="_suggest_word_8cs_source.html">SuggestWord.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a22ea01d1d6c66a7726720196092bcff1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SpellChecker.Net.Search.Spell.SuggestWord.freq</td>
</tr>
</table>
</div><div class="memdoc">
<p>The freq of the word</p>
<p>Definition at line <a class="el" href="_suggest_word_8cs_source.html#l00034">34</a> of file <a class="el" href="_suggest_word_8cs_source.html">SuggestWord.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab1c53890e31ecdad1ef2bab5854dd773"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SpellChecker.Net.Search.Spell.SuggestWord.score</td>
</tr>
</table>
</div><div class="memdoc">
<p>the score of the word</p>
<p>Definition at line <a class="el" href="_suggest_word_8cs_source.html#l00031">31</a> of file <a class="el" href="_suggest_word_8cs_source.html">SuggestWord.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a5699593761a8fc1a3ca04fa709411bd2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">System.String SpellChecker.Net.Search.Spell.SuggestWord.termString</td>
</tr>
</table>
</div><div class="memdoc">
<p>the suggested word</p>
<p>Definition at line <a class="el" href="_suggest_word_8cs_source.html#l00037">37</a> of file <a class="el" href="_suggest_word_8cs_source.html">SuggestWord.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/SpellChecker/Spell/<a class="el" href="_suggest_word_8cs_source.html">SuggestWord.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:59 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>