| <!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: core/Search/Payloads/PayloadFunction.cs Source File</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 port of the Lucene search engine library, written in C# and targeted at .NET runtime users.</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="../../annotated.html"><span>Classes</span></a></li> |
| <li class="current"><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="../../files.html"><span>File List</span></a></li> |
| <li><a href="../../globals.html"><span>File 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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</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="../../dir_1efe588324fc547683bba4a3f1bac847.html">core</a></li><li class="navelem"><a class="el" href="../../dir_56f9b3c34a852b92179da152ee78b823.html">Search</a></li><li class="navelem"><a class="el" href="../../dir_88bea2c074665fe818c2abb880c698ea.html">Payloads</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">PayloadFunction.cs</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="../../d2/d23/_payload_function_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* </span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">using</span> System;</div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>Lucene.Net.Search.Payloads</div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// <summary> An abstract class that defines a way for Payload*Query instances</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /// to transform the cumulative effects of payload scores for a document.</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// <seealso cref="Lucene.Net.Search.Payloads.PayloadTermQuery"> for more information</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// <p/></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// This class and its derivations are experimental and subject to change</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /// </seealso></span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span> [Serializable]</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="../../db/d3d/class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html"> 36</a></span>  <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="../../db/d3d/class_lucene_1_1_net_1_1_search_1_1_payloads_1_1_payload_function.html" title="An abstract class that defines a way for Payload*Query instances to transform the cumulative effects ...">PayloadFunction</a></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// <summary> Calculate the score up to this point for this doc and field</summary></span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// <param name="docId">The current doc</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// <param name="field">The field</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// <param name="start">The start position of the matching Span</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// <param name="end">The end position of the matching Span</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// <param name="numPayloadsSeen">The number of payloads seen so far</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// <param name="currentScore">The current score so far</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /// <param name="currentPayloadScore">The score for the current payload</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// <returns> The new current Score</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// </span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /// <seealso cref="Lucene.Net.Search.Spans.Spans"></span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> /// </seealso></span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keywordtype">float</span> CurrentScore(<span class="keywordtype">int</span> docId, System.String field, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> end, <span class="keywordtype">int</span> numPayloadsSeen, <span class="keywordtype">float</span> currentScore, <span class="keywordtype">float</span> currentPayloadScore);</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /// <summary> Calculate the final score for all the payloads seen so far for this doc/field</summary></span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /// <param name="docId">The current doc</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /// <param name="field">The current field</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> /// <param name="numPayloadsSeen">The total number of payloads seen on this document</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /// <param name="payloadScore">The raw score for those payloads</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /// <returns> The final score for the payloads</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keywordtype">float</span> DocScore(<span class="keywordtype">int</span> docId, System.String field, <span class="keywordtype">int</span> numPayloadsSeen, <span class="keywordtype">float</span> payloadScore);</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">abstract</span> <span class="keyword">public</span> <span class="keyword">override</span> <span class="keywordtype">int</span> GetHashCode();</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">abstract</span> <span class="keyword">public</span> <span class="keyword">override</span> <span class="keywordtype">bool</span> Equals(System.Object o);</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> }</div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:34:12 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> |
