| <!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.Payloads.PayloadFunction 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="namespace_lucene_1_1_net_1_1_search_1_1_payloads.html">Payloads</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html">PayloadFunction</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_payloads_1_1_payload_function-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Payloads.PayloadFunction Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An abstract class that defines a way for Payload*Query instances to transform the cumulative effects of payload scores for a document. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html#details">More...</a></p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_average_payload_function.html">Lucene.Net.Search.Payloads.AveragePayloadFunction</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_max_payload_function.html">Lucene.Net.Search.Payloads.MaxPayloadFunction</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_min_payload_function.html">Lucene.Net.Search.Payloads.MinPayloadFunction</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ae31516f9cdae9e244303d5bdfbbb4118"><td class="memItemLeft" align="right" valign="top">abstract float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html#ae31516f9cdae9e244303d5bdfbbb4118">CurrentScore</a> (int docId, System.String field, int start, int end, int numPayloadsSeen, float currentScore, float currentPayloadScore)</td></tr> |
| <tr class="memdesc:ae31516f9cdae9e244303d5bdfbbb4118"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the score up to this point for this doc and field <a href="#ae31516f9cdae9e244303d5bdfbbb4118"></a><br/></td></tr> |
| <tr class="separator:ae31516f9cdae9e244303d5bdfbbb4118"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a14004ee0e331308e12890f65cbc04db4"><td class="memItemLeft" align="right" valign="top">abstract float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html#a14004ee0e331308e12890f65cbc04db4">DocScore</a> (int docId, System.String field, int numPayloadsSeen, float payloadScore)</td></tr> |
| <tr class="memdesc:a14004ee0e331308e12890f65cbc04db4"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the final score for all the payloads seen so far for this doc/field <a href="#a14004ee0e331308e12890f65cbc04db4"></a><br/></td></tr> |
| <tr class="separator:a14004ee0e331308e12890f65cbc04db4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a526f3d2f6391db8db8ed936418c1c885"><td class="memItemLeft" align="right" valign="top">abstract override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html#a526f3d2f6391db8db8ed936418c1c885">GetHashCode</a> ()</td></tr> |
| <tr class="separator:a526f3d2f6391db8db8ed936418c1c885"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6d26ab75ea2c1167c974a96e8bc96a7"><td class="memItemLeft" align="right" valign="top">abstract override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html#af6d26ab75ea2c1167c974a96e8bc96a7">Equals</a> (System.Object o)</td></tr> |
| <tr class="separator:af6d26ab75ea2c1167c974a96e8bc96a7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An abstract class that defines a way for Payload*Query instances to transform the cumulative effects of payload scores for a document. </p> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_term_query.html" title="This class is very similar to Lucene.Net.Search.Spans.SpanTermQuery except that it factors in the val...">Lucene.Net.Search.Payloads.PayloadTermQuery</a></dd></dl> |
| <p>for more information</p> |
| <p>This class and its derivations are experimental and subject to change</p> |
| |
| <p>Definition at line <a class="el" href="_payload_function_8cs_source.html#l00036">36</a> of file <a class="el" href="_payload_function_8cs_source.html">PayloadFunction.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ae31516f9cdae9e244303d5bdfbbb4118"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract float Lucene.Net.Search.Payloads.PayloadFunction.CurrentScore </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">System.String </td> |
| <td class="paramname"><em>field</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">int </td> |
| <td class="paramname"><em>numPayloadsSeen</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>currentScore</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>currentPayloadScore</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Calculate the score up to this point for this doc and field</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">docId</td><td>The current doc </td></tr> |
| <tr><td class="paramname">field</td><td>The field </td></tr> |
| <tr><td class="paramname">start</td><td>The start position of the matching Span </td></tr> |
| <tr><td class="paramname">end</td><td>The end position of the matching Span </td></tr> |
| <tr><td class="paramname">numPayloadsSeen</td><td>The number of payloads seen so far </td></tr> |
| <tr><td class="paramname">currentScore</td><td>The current score so far </td></tr> |
| <tr><td class="paramname">currentPayloadScore</td><td>The score for the current payload </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><p class="startdd">The new current Score</p> |
| <p class="enddd"></p> |
| </dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html" title="Expert: an enumeration of span matches. Used to implement span searching. Each span represents a rang...">Lucene.Net.Search.Spans.Spans</a></dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_average_payload_function.html#a241c93fe7ce8b737bd8291c34eb540a0">Lucene.Net.Search.Payloads.AveragePayloadFunction</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_max_payload_function.html#a9cfb36340570e2ba07fe1604a5da2837">Lucene.Net.Search.Payloads.MaxPayloadFunction</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_min_payload_function.html#a3f217e596cc0c2a6b29f24a2cd6704a7">Lucene.Net.Search.Payloads.MinPayloadFunction</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a14004ee0e331308e12890f65cbc04db4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract float Lucene.Net.Search.Payloads.PayloadFunction.DocScore </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">System.String </td> |
| <td class="paramname"><em>field</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>numPayloadsSeen</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>payloadScore</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Calculate the final score for all the payloads seen so far for this doc/field</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">docId</td><td>The current doc </td></tr> |
| <tr><td class="paramname">field</td><td>The current field </td></tr> |
| <tr><td class="paramname">numPayloadsSeen</td><td>The total number of payloads seen on this document </td></tr> |
| <tr><td class="paramname">payloadScore</td><td>The raw score for those payloads </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The final score for the payloads </dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_max_payload_function.html#afc697d9b385ca564d9e6ac064f9c3af7">Lucene.Net.Search.Payloads.MaxPayloadFunction</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_min_payload_function.html#a48ce26108ff4b043e6f1b898ffe4617e">Lucene.Net.Search.Payloads.MinPayloadFunction</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_average_payload_function.html#a956b4d98880f229f65e46b492b634d7c">Lucene.Net.Search.Payloads.AveragePayloadFunction</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af6d26ab75ea2c1167c974a96e8bc96a7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract override bool Lucene.Net.Search.Payloads.PayloadFunction.Equals </td> |
| <td>(</td> |
| <td class="paramtype">System.Object </td> |
| <td class="paramname"><em>o</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_max_payload_function.html#ab31c66a61c1588fc00664d736db5affe">Lucene.Net.Search.Payloads.MaxPayloadFunction</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_min_payload_function.html#abaef56036b5cfb353fecb457f698c1a2">Lucene.Net.Search.Payloads.MinPayloadFunction</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_average_payload_function.html#ad3f4f9dc4c88da7803682ba33aa97dd5">Lucene.Net.Search.Payloads.AveragePayloadFunction</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a526f3d2f6391db8db8ed936418c1c885"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract override int Lucene.Net.Search.Payloads.PayloadFunction.GetHashCode </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_max_payload_function.html#ad7fc1cbed329ad9b71cbace6a4959fc3">Lucene.Net.Search.Payloads.MaxPayloadFunction</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_min_payload_function.html#ac7f88f535cb0323f8c758b5ef579c09c">Lucene.Net.Search.Payloads.MinPayloadFunction</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_average_payload_function.html#a7642cbe1ce857faf2b1a4c732d1e7e01">Lucene.Net.Search.Payloads.AveragePayloadFunction</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Search/Payloads/<a class="el" href="_payload_function_8cs_source.html">PayloadFunction.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:58 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> |
