| <!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.SimilarityDelegator 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_similarity_delegator.html">SimilarityDelegator</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_similarity_delegator-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.SimilarityDelegator Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Expert: Delegating scoring implementation. Useful in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a61ccd3cc51e811a537f7929e98302fd3" title="Expert: Returns the Similarity implementation to be used for this query. Subclasses may override this...">Query.GetSimilarity(Searcher)</a> implementations, to override only certain methods of a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html" title="An abstract base class for search implementations. Implements the main search methods.">Searcher</a>'s Similiarty implementation.. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_similarity_delegator.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.BooleanQuery.AnonymousClassSimilarityDelegator, and Lucene.Net.Search.FuzzyLikeThisQuery.FuzzyTermQuery.AnonymousSimilarityDelegator.</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:a9450ddd467434d041bcfe2f64fbe920a"><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_delegator.html#a9450ddd467434d041bcfe2f64fbe920a">SimilarityDelegator</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a> delegee)</td></tr> |
| <tr class="memdesc:a9450ddd467434d041bcfe2f64fbe920a"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <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> that delegates all methods to another. <a href="#a9450ddd467434d041bcfe2f64fbe920a"></a><br/></td></tr> |
| <tr class="separator:a9450ddd467434d041bcfe2f64fbe920a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a905e46224a562ecfcf90f3aed93658ea"><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_similarity_delegator.html#a905e46224a562ecfcf90f3aed93658ea">ComputeNorm</a> (System.String fieldName, <a class="el" href="_fieldable_8cs.html#a7e48939924d26d58803de390e852a01c">FieldInvertState</a> state)</td></tr> |
| <tr class="memdesc:a905e46224a562ecfcf90f3aed93658ea"><td class="mdescLeft"> </td><td class="mdescRight">Compute the normalization value for a field, given the accumulated state of term processing for this field (see <a class="el" href="_similarity_delegator_8cs.html#a7e48939924d26d58803de390e852a01c">FieldInvertState</a>). <a href="#a905e46224a562ecfcf90f3aed93658ea"></a><br/></td></tr> |
| <tr class="separator:a905e46224a562ecfcf90f3aed93658ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d802d4a81598d445aa7491a2afb1a73"><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_similarity_delegator.html#a3d802d4a81598d445aa7491a2afb1a73">LengthNorm</a> (System.String fieldName, int numTerms)</td></tr> |
| <tr class="memdesc:a3d802d4a81598d445aa7491a2afb1a73"><td class="mdescLeft"> </td><td class="mdescRight">Computes the normalization value for a field given the total number of terms contained in a field. These values, together with field boosts, are stored in an index and multipled into scores for hits on each field by the search code. <a href="#a3d802d4a81598d445aa7491a2afb1a73"></a><br/></td></tr> |
| <tr class="separator:a3d802d4a81598d445aa7491a2afb1a73"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a34679dbcd3bccf08609065b1c828a082"><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_similarity_delegator.html#a34679dbcd3bccf08609065b1c828a082">QueryNorm</a> (float sumOfSquaredWeights)</td></tr> |
| <tr class="memdesc:a34679dbcd3bccf08609065b1c828a082"><td class="mdescLeft"> </td><td class="mdescRight">Computes the normalization value for a query given the sum of the squared weights of each of the query terms. This value is then multipled into the weight of each query term. <a href="#a34679dbcd3bccf08609065b1c828a082"></a><br/></td></tr> |
| <tr class="separator:a34679dbcd3bccf08609065b1c828a082"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af81e4f7ca48c67bbe969fd00ac586311"><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_similarity_delegator.html#af81e4f7ca48c67bbe969fd00ac586311">Tf</a> (float freq)</td></tr> |
| <tr class="memdesc:af81e4f7ca48c67bbe969fd00ac586311"><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_delegator.html#aed1d763dd3456f19293d8676d3e9499e" 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="#af81e4f7ca48c67bbe969fd00ac586311"></a><br/></td></tr> |
| <tr class="separator:af81e4f7ca48c67bbe969fd00ac586311"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0e09ab33cd5c4b39b1ceb7668692f2d2"><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_similarity_delegator.html#a0e09ab33cd5c4b39b1ceb7668692f2d2">SloppyFreq</a> (int distance)</td></tr> |
| <tr class="memdesc:a0e09ab33cd5c4b39b1ceb7668692f2d2"><td class="mdescLeft"> </td><td class="mdescRight">Computes the amount of a sloppy phrase match, based on an edit distance. This value is summed for each sloppy phrase match in a document to form the frequency that is passed to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity_delegator.html#af81e4f7ca48c67bbe969fd00ac586311" title="Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied...">Tf(float)</a>. <a href="#a0e09ab33cd5c4b39b1ceb7668692f2d2"></a><br/></td></tr> |
| <tr class="separator:a0e09ab33cd5c4b39b1ceb7668692f2d2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed1d763dd3456f19293d8676d3e9499e"><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_similarity_delegator.html#aed1d763dd3456f19293d8676d3e9499e">Idf</a> (int docFreq, int numDocs)</td></tr> |
| <tr class="memdesc:aed1d763dd3456f19293d8676d3e9499e"><td class="mdescLeft"> </td><td class="mdescRight">Computes a score factor based on a term's document frequency (the number of documents which contain the term). This value is multiplied by the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#ab08940fe117d42b282f342a09b6beba9" title="Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied...">Tf(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="#aed1d763dd3456f19293d8676d3e9499e"></a><br/></td></tr> |
| <tr class="separator:aed1d763dd3456f19293d8676d3e9499e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a39feb6fe73a81bf88f4601f1f0bbaeda"><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_similarity_delegator.html#a39feb6fe73a81bf88f4601f1f0bbaeda">Coord</a> (int overlap, int maxOverlap)</td></tr> |
| <tr class="memdesc:a39feb6fe73a81bf88f4601f1f0bbaeda"><td class="mdescLeft"> </td><td class="mdescRight">Computes a score factor based on the fraction of all query terms that a document contains. This value is multiplied into scores. <a href="#a39feb6fe73a81bf88f4601f1f0bbaeda"></a><br/></td></tr> |
| <tr class="separator:a39feb6fe73a81bf88f4601f1f0bbaeda"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a590112346777f14e0f3e32603f41e0a8"><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_similarity_delegator.html#a590112346777f14e0f3e32603f41e0a8">ScorePayload</a> (int docId, string fieldName, int start, int end, byte[] payload, int offset, int length)</td></tr> |
| <tr class="separator:a590112346777f14e0f3e32603f41e0a8"><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="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> |
| <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> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Expert: Delegating scoring implementation. Useful in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html#a61ccd3cc51e811a537f7929e98302fd3" title="Expert: Returns the Similarity implementation to be used for this query. Subclasses may override this...">Query.GetSimilarity(Searcher)</a> implementations, to override only certain methods of a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html" title="An abstract base class for search implementations. Implements the main search methods.">Searcher</a>'s Similiarty implementation.. </p> |
| |
| <p>Definition at line <a class="el" href="_similarity_delegator_8cs_source.html#l00029">29</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a9450ddd467434d041bcfe2f64fbe920a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.SimilarityDelegator.SimilarityDelegator </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html">Similarity</a> </td> |
| <td class="paramname"><em>delegee</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct a <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> that delegates all methods to another.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">delegee</td><td>the <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 to delegate to</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_similarity_delegator_8cs_source.html#l00035">35</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a905e46224a562ecfcf90f3aed93658ea"></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.SimilarityDelegator.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>Compute the normalization value for a field, given the accumulated state of term processing for this field (see <a class="el" href="_similarity_delegator_8cs.html#a7e48939924d26d58803de390e852a01c">FieldInvertState</a>). </p> |
| <p>Implementations should calculate a float value based on the field state and then return that value.</p> |
| <p>For backward compatibility this method by default calls LengthNorm(String, int) passing FieldInvertState.Length as the second argument, and then multiplies this value by FieldInvertState.Boost.</p> |
| <p><b>WARNING</b>: This API is new and experimental and may suddenly change.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">field</td><td>field name </td></tr> |
| <tr><td class="paramname">state</td><td>current processing state for this field </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the calculated float norm </dd></dl> |
| |
| <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="_similarity_delegator_8cs_source.html#l00040">40</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a39feb6fe73a81bf88f4601f1f0bbaeda"></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.SimilarityDelegator.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>Computes a score factor based on the fraction of all query terms that a document contains. This value is multiplied into scores. </p> |
| <p>The presence of a large portion of the query terms indicates a better match with the query, so implementations of this method usually return larger values when the ratio between these parameters is large and smaller values when the ratio between them is small.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">overlap</td><td>the number of query terms matched in the document </td></tr> |
| <tr><td class="paramname">maxOverlap</td><td>the total number of terms in the query </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a score factor based on term overlap with the query </dd></dl> |
| |
| <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="_similarity_delegator_8cs_source.html#l00070">70</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aed1d763dd3456f19293d8676d3e9499e"></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.SimilarityDelegator.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>Computes a score factor based on a term's document frequency (the number of documents which contain the term). This value is multiplied by the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#ab08940fe117d42b282f342a09b6beba9" title="Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied...">Tf(int)</a> factor for each term in the query and these products are then summed to form the initial score for a document. </p> |
| <p>Terms that occur in fewer documents are better indicators of topic, so implementations of this method usually return larger values for rare terms, and smaller values for common terms.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">docFreq</td><td>the number of documents which contain the term </td></tr> |
| <tr><td class="paramname">numDocs</td><td>the total number of documents in the collection </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a score factor based on the term's document frequency </dd></dl> |
| |
| <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="_similarity_delegator_8cs_source.html#l00065">65</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3d802d4a81598d445aa7491a2afb1a73"></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.SimilarityDelegator.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>numTokens</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>Computes the normalization value for a field given the total number of terms contained in a field. These values, together with field boosts, are stored in an index and multipled into scores for hits on each field by the search code. </p> |
| <p>Matches in longer fields are less precise, so implementations of this method usually return smaller values when <code>numTokens</code> is large, and larger values when <code>numTokens</code> is small.</p> |
| <p>Note that the return values are computed under Lucene.Net.Index.IndexWriter.AddDocument(Lucene.Net.Documents.Document) and then stored using <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#abb8c94a5e3079a47004af1bf117af1de" title="Encodes a normalization factor for storage in an index.">EncodeNorm(float)</a>. Thus they have limited precision, and documents must be re-indexed if this method is altered.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldName</td><td>the name of the field </td></tr> |
| <tr><td class="paramname">numTokens</td><td>the total number of tokens contained in fields named <em>fieldName</em> of <em>doc</em>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><p class="startdd">a normalization factor for hits on this field of this document</p> |
| <p class="enddd"></p> |
| </dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd>Lucene.Net.Documents.AbstractField.Boost</dd></dl> |
| |
| <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="_similarity_delegator_8cs_source.html#l00045">45</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a34679dbcd3bccf08609065b1c828a082"></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.SimilarityDelegator.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>Computes the normalization value for a query given the sum of the squared weights of each of the query terms. This value is then multipled into the weight of each query term. </p> |
| <p>This does not affect ranking, but rather just attempts to make scores from different queries comparable.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">sumOfSquaredWeights</td><td>the sum of the squares of query term weights </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a normalization factor for query weights </dd></dl> |
| |
| <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="_similarity_delegator_8cs_source.html#l00050">50</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a590112346777f14e0f3e32603f41e0a8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override float Lucene.Net.Search.SimilarityDelegator.ScorePayload </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>docId</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">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>start</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>end</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>payload</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>offset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_similarity_delegator_8cs_source.html#l00075">75</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0e09ab33cd5c4b39b1ceb7668692f2d2"></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.SimilarityDelegator.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>Computes the amount of a sloppy phrase match, based on an edit distance. This value is summed for each sloppy phrase match in a document to form the frequency that is passed to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity_delegator.html#af81e4f7ca48c67bbe969fd00ac586311" title="Computes a score factor based on a term or phrase's frequency in a document. This value is multiplied...">Tf(float)</a>. </p> |
| <p>A phrase match with a small edit distance to a document passage more closely matches the document, so implementations of this method usually return larger values when the edit distance is small and smaller values when it is large.</p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html#ab0b42bf7038acb8464c7a31de6c1fb22" title="Sets the number of other words permitted between words in query phrase. If zero, then this is an exac...">PhraseQuery.Slop</a></dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">distance</td><td>the edit distance of this sloppy phrase match </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the frequency increment for this match </dd></dl> |
| |
| <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="_similarity_delegator_8cs_source.html#l00060">60</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af81e4f7ca48c67bbe969fd00ac586311"></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.SimilarityDelegator.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>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_delegator.html#aed1d763dd3456f19293d8676d3e9499e" 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. </p> |
| <p>Terms and phrases repeated in a document indicate the topic of the document, so implementations of this method usually return larger values when <code>freq</code> is large, and smaller values when <code>freq</code> is small.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">freq</td><td>the frequency of a term within a document </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a score factor based on a term's within-document frequency </dd></dl> |
| |
| <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="_similarity_delegator_8cs_source.html#l00055">55</a> of file <a class="el" href="_similarity_delegator_8cs_source.html">SimilarityDelegator.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="_similarity_delegator_8cs_source.html">SimilarityDelegator.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:57 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> |
