| <!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.Search.DefaultSimilarity 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_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_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html">DefaultSimilarity</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_default_similarity-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.DefaultSimilarity Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Expert: Default scoring implementation. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Inherited by Lucene.Net.Search.BoostingQuery.AnonymousDefaultSimilarity.</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:ad14b290caf25c05dc441a35ddff28969"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#ad14b290caf25c05dc441a35ddff28969">ComputeNorm</a> (System.String field, <a class="el" href="_fieldable_8cs.html#a7e48939924d26d58803de390e852a01c">FieldInvertState</a> state)</td></tr> |
| <tr class="memdesc:ad14b290caf25c05dc441a35ddff28969"><td class="mdescLeft"> </td><td class="mdescRight">Implemented as <code>state.getBoost()*lengthNorm(numTerms)</code>, where <code>numTerms</code> is FieldInvertState.Length if <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#a196fd2865faa2cd7c2ddf7e742cf7827" title="Determines whether overlap tokens (Tokens with 0 position increment) are ignored when computing norm...">DiscountOverlaps</a> is false, else it's FieldInvertState.Length <a href="#ad14b290caf25c05dc441a35ddff28969"></a><br/></td></tr> |
| <tr class="separator:ad14b290caf25c05dc441a35ddff28969"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abf30485ea3b8d9b662d2159b2be79fee"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#abf30485ea3b8d9b662d2159b2be79fee">LengthNorm</a> (System.String fieldName, int numTerms)</td></tr> |
| <tr class="memdesc:abf30485ea3b8d9b662d2159b2be79fee"><td class="mdescLeft"> </td><td class="mdescRight">Implemented as <code>1/sqrt(numTerms)</code>. <a href="#abf30485ea3b8d9b662d2159b2be79fee"></a><br/></td></tr> |
| <tr class="separator:abf30485ea3b8d9b662d2159b2be79fee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aac12c840f91004aa02461da448b42f2d"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#aac12c840f91004aa02461da448b42f2d">QueryNorm</a> (float sumOfSquaredWeights)</td></tr> |
| <tr class="memdesc:aac12c840f91004aa02461da448b42f2d"><td class="mdescLeft"> </td><td class="mdescRight">Implemented as <code>1/sqrt(sumOfSquaredWeights)</code>. <a href="#aac12c840f91004aa02461da448b42f2d"></a><br/></td></tr> |
| <tr class="separator:aac12c840f91004aa02461da448b42f2d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a23cb836777a596d02d86de28e723e826"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#a23cb836777a596d02d86de28e723e826">Tf</a> (float freq)</td></tr> |
| <tr class="memdesc:a23cb836777a596d02d86de28e723e826"><td class="mdescLeft"> </td><td class="mdescRight">Implemented as <code>sqrt(freq)</code>. <a href="#a23cb836777a596d02d86de28e723e826"></a><br/></td></tr> |
| <tr class="separator:a23cb836777a596d02d86de28e723e826"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38309093c061fe7b92edab56091df6ca"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#a38309093c061fe7b92edab56091df6ca">SloppyFreq</a> (int distance)</td></tr> |
| <tr class="memdesc:a38309093c061fe7b92edab56091df6ca"><td class="mdescLeft"> </td><td class="mdescRight">Implemented as <code>1 / (distance + 1)</code>. <a href="#a38309093c061fe7b92edab56091df6ca"></a><br/></td></tr> |
| <tr class="separator:a38309093c061fe7b92edab56091df6ca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a373cb8d80a99d28e1cfc2a291fb0b8dc"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#a373cb8d80a99d28e1cfc2a291fb0b8dc">Idf</a> (int docFreq, int numDocs)</td></tr> |
| <tr class="memdesc:a373cb8d80a99d28e1cfc2a291fb0b8dc"><td class="mdescLeft"> </td><td class="mdescRight">Implemented as <code>log(numDocs/(docFreq+1)) + 1</code>. <a href="#a373cb8d80a99d28e1cfc2a291fb0b8dc"></a><br/></td></tr> |
| <tr class="separator:a373cb8d80a99d28e1cfc2a291fb0b8dc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a52b567fd4d51b9ed6ab0afe74f96efdc"><td class="memItemLeft" align="right" valign="top">override float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#a52b567fd4d51b9ed6ab0afe74f96efdc">Coord</a> (int overlap, int maxOverlap)</td></tr> |
| <tr class="memdesc:a52b567fd4d51b9ed6ab0afe74f96efdc"><td class="mdescLeft"> </td><td class="mdescRight">Implemented as <code>overlap / maxOverlap</code>. <a href="#a52b567fd4d51b9ed6ab0afe74f96efdc"></a><br/></td></tr> |
| <tr class="separator:a52b567fd4d51b9ed6ab0afe74f96efdc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Lucene.Net.Search.Similarity</a></td></tr> |
| <tr class="memitem:ab08940fe117d42b282f342a09b6beba9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#ab08940fe117d42b282f342a09b6beba9">Tf</a> (int freq)</td></tr> |
| <tr class="memdesc:ab08940fe117d42b282f342a09b6beba9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied by the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a6cb62d3308ca06f13600cb714a8e1d73" title="Computes a score factor based on a term's document frequency (the number of documents which contain t...">Idf(int, int)</a> factor for each term in the query and these products are then summed to form the initial score for a document. <a href="#ab08940fe117d42b282f342a09b6beba9"></a><br/></td></tr> |
| <tr class="separator:ab08940fe117d42b282f342a09b6beba9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9bfd3c3d2722ff351f7c5793f0ece506 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_phrase_query_8cs.html#a6210369909e0fef392bc63926b45beaf">IDFExplanation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a9bfd3c3d2722ff351f7c5793f0ece506">IdfExplain</a> (<a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> term, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> searcher)</td></tr> |
| <tr class="memdesc:a9bfd3c3d2722ff351f7c5793f0ece506 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Computes a score factor for a simple term and returns an explanation for that score factor. <a href="#a9bfd3c3d2722ff351f7c5793f0ece506"></a><br/></td></tr> |
| <tr class="separator:a9bfd3c3d2722ff351f7c5793f0ece506 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acaefd61909f04a234baaec33d387e64e inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_phrase_query_8cs.html#a6210369909e0fef392bc63926b45beaf">IDFExplanation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#acaefd61909f04a234baaec33d387e64e">IdfExplain</a> (ICollection< <a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> > terms, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> searcher)</td></tr> |
| <tr class="memdesc:acaefd61909f04a234baaec33d387e64e inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Computes a score factor for a phrase. <a href="#acaefd61909f04a234baaec33d387e64e"></a><br/></td></tr> |
| <tr class="separator:acaefd61909f04a234baaec33d387e64e inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5973cd115b539d631e994fdf86021439 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a5973cd115b539d631e994fdf86021439">ScorePayload</a> (int docId, System.String fieldName, int start, int end, byte[] payload, int offset, int length)</td></tr> |
| <tr class="memdesc:a5973cd115b539d631e994fdf86021439 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Calculate a scoring factor based on the data in the payload. Overriding implementations are responsible for interpreting what is in the payload. <a class="el" href="namespace_lucene.html">Lucene</a> makes no assumptions about what is in the byte array. The default implementation returns 1. <a href="#a5973cd115b539d631e994fdf86021439"></a><br/></td></tr> |
| <tr class="separator:a5973cd115b539d631e994fdf86021439 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </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:a196fd2865faa2cd7c2ddf7e742cf7827"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#a196fd2865faa2cd7c2ddf7e742cf7827">DiscountOverlaps</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a196fd2865faa2cd7c2ddf7e742cf7827"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether overlap tokens (Tokens with 0 position increment) are ignored when computing norm. By default this is false, meaning overlap tokens are counted just like non-overlap tokens. <a href="#a196fd2865faa2cd7c2ddf7e742cf7827"></a><br/></td></tr> |
| <tr class="separator:a196fd2865faa2cd7c2ddf7e742cf7827"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_similarity"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_similarity')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Lucene.Net.Search.Similarity</a></td></tr> |
| <tr class="memitem:a374d891e671bbaca17d776be505bc944 inherit properties_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a374d891e671bbaca17d776be505bc944">Default</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a374d891e671bbaca17d776be505bc944 inherit properties_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the default <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html" title="Expert: Scoring API. Subclasses implement search scoring.">Similarity</a> implementation used by indexing and search code. This is initially an instance of <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html" title="Expert: Default scoring implementation. ">DefaultSimilarity</a>. <a href="#a374d891e671bbaca17d776be505bc944"></a><br/></td></tr> |
| <tr class="separator:a374d891e671bbaca17d776be505bc944 inherit properties_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Lucene.Net.Search.Similarity</a></td></tr> |
| <tr class="memitem:acd2a4329c78ea23877a82c425fe76188 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#acd2a4329c78ea23877a82c425fe76188">DecodeNorm</a> (byte b)</td></tr> |
| <tr class="memdesc:acd2a4329c78ea23877a82c425fe76188 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a normalization factor stored in an index. <a href="#acd2a4329c78ea23877a82c425fe76188"></a><br/></td></tr> |
| <tr class="separator:acd2a4329c78ea23877a82c425fe76188 inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad157cc6f3b9070ecd1691d4ffde1eb4b inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">static float[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#ad157cc6f3b9070ecd1691d4ffde1eb4b">GetNormDecoder</a> ()</td></tr> |
| <tr class="memdesc:ad157cc6f3b9070ecd1691d4ffde1eb4b inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Returns a table for decoding normalization bytes. <a href="#ad157cc6f3b9070ecd1691d4ffde1eb4b"></a><br/></td></tr> |
| <tr class="separator:ad157cc6f3b9070ecd1691d4ffde1eb4b inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb8c94a5e3079a47004af1bf117af1de inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">static byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#abb8c94a5e3079a47004af1bf117af1de">EncodeNorm</a> (float f)</td></tr> |
| <tr class="memdesc:abb8c94a5e3079a47004af1bf117af1de inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="mdescLeft"> </td><td class="mdescRight">Encodes a normalization factor for storage in an index. <a href="#abb8c94a5e3079a47004af1bf117af1de"></a><br/></td></tr> |
| <tr class="separator:abb8c94a5e3079a47004af1bf117af1de inherit pub_static_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_attribs_class_lucene_1_1_net_1_1_search_1_1_similarity"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_lucene_1_1_net_1_1_search_1_1_similarity')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Lucene.Net.Search.Similarity</a></td></tr> |
| <tr class="memitem:a7179ebc4356c719c153df4f93f56800e inherit pub_attribs_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a7179ebc4356c719c153df4f93f56800e">NO_DOC_ID_PROVIDED</a> = - 1</td></tr> |
| <tr class="separator:a7179ebc4356c719c153df4f93f56800e inherit pub_attribs_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_search_1_1_similarity')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Lucene.Net.Search.Similarity</a></td></tr> |
| <tr class="memitem:a6d67e665ab410e69b7cfbf3a941e53dd inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a6d67e665ab410e69b7cfbf3a941e53dd">Similarity</a> ()</td></tr> |
| <tr class="separator:a6d67e665ab410e69b7cfbf3a941e53dd inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_similarity"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Expert: Default scoring implementation. </p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00027">27</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ad14b290caf25c05dc441a35ddff28969"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.DefaultSimilarity.ComputeNorm </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>field</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="_fieldable_8cs.html#a7e48939924d26d58803de390e852a01c">FieldInvertState</a> </td> |
| <td class="paramname"><em>state</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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented as <code>state.getBoost()*lengthNorm(numTerms)</code>, where <code>numTerms</code> is FieldInvertState.Length if <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#a196fd2865faa2cd7c2ddf7e742cf7827" title="Determines whether overlap tokens (Tokens with 0 position increment) are ignored when computing norm...">DiscountOverlaps</a> is false, else it's FieldInvertState.Length </p> |
| <ul> |
| <li>FieldInvertState.NumOverlap</li> |
| </ul> |
| <p><b>WARNING</b>: This API is new and experimental, and may suddenly change.</p> |
| |
| <p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#accbd724f439b07b64379b590bcd2ba81">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00040">40</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a52b567fd4d51b9ed6ab0afe74f96efdc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.DefaultSimilarity.Coord </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>overlap</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maxOverlap</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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented as <code>overlap / maxOverlap</code>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#acef90f6b9b05e7f0d63e145987229e85">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00081">81</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a373cb8d80a99d28e1cfc2a291fb0b8dc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.DefaultSimilarity.Idf </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>docFreq</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>numDocs</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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented as <code>log(numDocs/(docFreq+1)) + 1</code>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a6cb62d3308ca06f13600cb714a8e1d73">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00075">75</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abf30485ea3b8d9b662d2159b2be79fee"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.DefaultSimilarity.LengthNorm </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>numTerms</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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented as <code>1/sqrt(numTerms)</code>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a3cb3ee80bc11c2d608ce673ead8bfcba">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00051">51</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aac12c840f91004aa02461da448b42f2d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.DefaultSimilarity.QueryNorm </td> |
| <td>(</td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>sumOfSquaredWeights</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>Implemented as <code>1/sqrt(sumOfSquaredWeights)</code>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a941d4d16d71b59858e360de8c2d59371">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00057">57</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a38309093c061fe7b92edab56091df6ca"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.DefaultSimilarity.SloppyFreq </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>distance</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>Implemented as <code>1 / (distance + 1)</code>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#a58d84da69da3185f4c2548d80d02fd26">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00069">69</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a23cb836777a596d02d86de28e723e826"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.DefaultSimilarity.Tf </td> |
| <td>(</td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>freq</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>Implemented as <code>sqrt(freq)</code>. </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#ad75051e13336926fdc23ed04958d1409">Lucene.Net.Search.Similarity</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00063">63</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a196fd2865faa2cd7c2ddf7e742cf7827"></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.Search.DefaultSimilarity.DiscountOverlaps</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Determines whether overlap tokens (Tokens with 0 position increment) are ignored when computing norm. By default this is false, meaning overlap tokens are counted just like non-overlap tokens. </p> |
| <p><b>WARNING</b>: This API is new and experimental, and may suddenly change.</p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_default_similarity.html#ad14b290caf25c05dc441a35ddff28969" title="Implemented as state.getBoost()*lengthNorm(numTerms), where numTerms is FieldInvertState.Length if DiscountOverlaps is false, else it's FieldInvertState.Length">ComputeNorm</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_default_similarity_8cs_source.html#l00103">103</a> of file <a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Search/<a class="el" href="_default_similarity_8cs_source.html">DefaultSimilarity.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:56 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> |
