| <!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: WorldNet.Net.SynExpand 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 |
|  <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 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</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> |
| <!-- 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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_world_net.html">WorldNet</a></li><li class="navelem"><a class="el" href="namespace_world_net_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="class_world_net_1_1_net_1_1_syn_expand.html">SynExpand</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="class_world_net_1_1_net_1_1_syn_expand-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">WorldNet.Net.SynExpand Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Expand a query by looking up synonyms for every term. You need to invoke <a class="el" href="class_world_net_1_1_net_1_1_syn_expand_1_1_syns2_index.html" title="From project WordNet.Net.Syns2Index ">Syns2Index</a> first to build the synonym index. |
| <a href="class_world_net_1_1_net_1_1_syn_expand.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><b>CollectorImpl</b></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">CollectorImpl <br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_world_net_1_1_net_1_1_syn_expand_1_1_syns2_index.html">Syns2Index</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">From project WordNet.Net.Syns2Index <a href="class_world_net_1_1_net_1_1_syn_expand_1_1_syns2_index.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><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:a72c02703df2aea4ed8b141f63c4eea69"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_world_net_1_1_net_1_1_syn_expand.html#a72c02703df2aea4ed8b141f63c4eea69">Main</a> (String[] args)</td></tr> |
| <tr class="memdesc:a72c02703df2aea4ed8b141f63c4eea69"><td class="mdescLeft"> </td><td class="mdescRight">Test driver for synonym expansion. Uses boost factor of 0.9 for illustrative purposes. <a href="#a72c02703df2aea4ed8b141f63c4eea69"></a><br/></td></tr> |
| <tr class="separator:a72c02703df2aea4ed8b141f63c4eea69"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaeaab182949af969bd8edd56adbfef4a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_world_net_1_1_net_1_1_syn_expand.html#aaeaab182949af969bd8edd56adbfef4a">Expand</a> (String query, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> syns, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> a, String field, float boost)</td></tr> |
| <tr class="memdesc:aaeaab182949af969bd8edd56adbfef4a"><td class="mdescLeft"> </td><td class="mdescRight">Perform synonym expansion on a query. <a href="#aaeaab182949af969bd8edd56adbfef4a"></a><br/></td></tr> |
| <tr class="separator:aaeaab182949af969bd8edd56adbfef4a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Expand a query by looking up synonyms for every term. You need to invoke <a class="el" href="class_world_net_1_1_net_1_1_syn_expand_1_1_syns2_index.html" title="From project WordNet.Net.Syns2Index ">Syns2Index</a> first to build the synonym index. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_world_net_1_1_net_1_1_syn_expand_1_1_syns2_index.html" title="From project WordNet.Net.Syns2Index ">Syns2Index</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_syn_expand_8cs_source.html#l00038">38</a> of file <a class="el" href="_syn_expand_8cs_source.html">SynExpand.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aaeaab182949af969bd8edd56adbfef4a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> WorldNet.Net.SynExpand.Expand </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>query</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> </td> |
| <td class="paramname"><em>syns</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_analyzer.html">Analyzer</a> </td> |
| <td class="paramname"><em>a</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>field</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>boost</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Perform synonym expansion on a query. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">query</td><td>users query that is assumed to not have any "special" query syntax, thus it should be just normal words, so "big dog" makes sense, but a query like "title:foo^1.2" doesn't as this should presumably be passed directly to the default query parser </td></tr> |
| <tr><td class="paramname">syns</td><td>a opened to the <a class="el" href="namespace_lucene.html">Lucene</a> index you previously created with <a class="el" href="class_world_net_1_1_net_1_1_syn_expand_1_1_syns2_index.html" title="From project WordNet.Net.Syns2Index ">Syns2Index</a>. The searcher is not closed or otherwise altered. </td></tr> |
| <tr><td class="paramname">a</td><td>optional analyzer used to parse the users query else <a class="el" href="_syns2_index_8cs.html#a95c37490d2ac2832fbd090844a6c8d23">StandardAnalyzer</a> is used </td></tr> |
| <tr><td class="paramname">field</td><td>optional field name to search in or null if you want the default of "contents" </td></tr> |
| <tr><td class="paramname">boost</td><td>optional boost applied to synonyms else no boost is applied </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the expanded Query </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_syn_expand_8cs_source.html#l00085">85</a> of file <a class="el" href="_syn_expand_8cs_source.html">SynExpand.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a72c02703df2aea4ed8b141f63c4eea69"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void WorldNet.Net.SynExpand.Main </td> |
| <td>(</td> |
| <td class="paramtype">String[] </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 driver for synonym expansion. Uses boost factor of 0.9 for illustrative purposes. </p> |
| <p>If you pass in the query "big dog" then it prints out:</p> |
| <pre> |
| Query: big adult^0.9 bad^0.9 bighearted^0.9 boastful^0.9 boastfully^0.9 bounteous^0.9 bountiful^0.9 braggy^0.9 crowing^0.9 freehanded^0.9 giving^0.9 grown^0.9 grownup^0.9 handsome^0.9 large^0.9 liberal^0.9 magnanimous^0.9 momentous^0.9 openhanded^0.9 prominent^0.9 swelled^0.9 vainglorious^0.9 vauntingly^0.9 |
| dog andiron^0.9 blackguard^0.9 bounder^0.9 cad^0.9 chase^0.9 click^0.9 detent^0.9 dogtooth^0.9 firedog^0.9 frank^0.9 frankfurter^0.9 frump^0.9 heel^0.9 hotdog^0.9 hound^0.9 pawl^0.9 tag^0.9 tail^0.9 track^0.9 trail^0.9 weenie^0.9 wiener^0.9 wienerwurst^0.9 |
| </pre> |
| <p>Definition at line <a class="el" href="_syn_expand_8cs_source.html#l00054">54</a> of file <a class="el" href="_syn_expand_8cs_source.html">SynExpand.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/WordNet/SynExpand/<a class="el" href="_syn_expand_8cs_source.html">SynExpand.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
