blob: e84849723dd039068018441593ec82e877718bf9 [file] [log] [blame]
<!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.Spans.SpanWeight 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
&#160;<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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_spans.html">Spans</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html">SpanWeight</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Spans.SpanWeight Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Expert-only. Public for use by other weight implementations
<a href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html">Lucene.Net.Search.Weight</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:a88c974b7d744936d0a229b5f67467767"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#a88c974b7d744936d0a229b5f67467767">SpanWeight</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_query.html">SpanQuery</a> query, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a> searcher)</td></tr>
<tr class="separator:a88c974b7d744936d0a229b5f67467767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8fe1b261bc9ba61ece412ad37b62af3"><td class="memItemLeft" align="right" valign="top">override float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#aa8fe1b261bc9ba61ece412ad37b62af3">GetSumOfSquaredWeights</a> ()</td></tr>
<tr class="memdesc:aa8fe1b261bc9ba61ece412ad37b62af3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sum of squared weights of contained query clauses. <a href="#aa8fe1b261bc9ba61ece412ad37b62af3"></a><br/></td></tr>
<tr class="separator:aa8fe1b261bc9ba61ece412ad37b62af3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab834fae835530448639f6edd09fa80f3"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#ab834fae835530448639f6edd09fa80f3">Normalize</a> (float queryNorm)</td></tr>
<tr class="memdesc:ab834fae835530448639f6edd09fa80f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns the query normalization factor to this. <a href="#ab834fae835530448639f6edd09fa80f3"></a><br/></td></tr>
<tr class="separator:ab834fae835530448639f6edd09fa80f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf28e7998b1ef802e2cfd8e61c261a35"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Scorer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#acf28e7998b1ef802e2cfd8e61c261a35">Scorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, bool scoreDocsInOrder, bool topScorer)</td></tr>
<tr class="memdesc:acf28e7998b1ef802e2cfd8e61c261a35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> which scores documents in/out-of order according to <code>scoreDocsInOrder</code>. <b>NOTE:</b> even if <code>scoreDocsInOrder</code> is false, it is recommended to check whether the returned <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a></code> indeed scores documents out of order (i.e., call <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#ad298cceb7caae992cbc9770dc5891cf7" title="Returns true iff this implementation scores docs only out of order. This method is used in conjunctio...">GetScoresDocsOutOfOrder()</a>), as some <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a></code> implementations will always return documents in-order.<br/>
<b>NOTE:</b> null can be returned if no documents will be scored by this query. <a href="#acf28e7998b1ef802e2cfd8e61c261a35"></a><br/></td></tr>
<tr class="separator:acf28e7998b1ef802e2cfd8e61c261a35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65e4d9aa5279522c3c0a8486e544bd27"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#a65e4d9aa5279522c3c0a8486e544bd27">Explain</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int doc)</td></tr>
<tr class="memdesc:a65e4d9aa5279522c3c0a8486e544bd27"><td class="mdescLeft">&#160;</td><td class="mdescRight">An explanation of the score computation for the named document. <a href="#a65e4d9aa5279522c3c0a8486e544bd27"></a><br/></td></tr>
<tr class="separator:a65e4d9aa5279522c3c0a8486e544bd27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_weight"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_weight')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html">Lucene.Net.Search.Weight</a></td></tr>
<tr class="memitem:ad298cceb7caae992cbc9770dc5891cf7 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#ad298cceb7caae992cbc9770dc5891cf7">GetScoresDocsOutOfOrder</a> ()</td></tr>
<tr class="memdesc:ad298cceb7caae992cbc9770dc5891cf7 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true iff this implementation scores docs only out of order. This method is used in conjunction with <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html" title="Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. ">Collector</a>'s <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html#a07ed980f78f4da95c2968646c8b0c279">AcceptsDocsOutOfOrder</a> and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#a87064513b858e1608bf7c66731f89a6b" title="Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder. NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (i.e., call GetScoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order. NOTE: null can be returned if no documents will be scored by this query.">Scorer(Lucene.Net.Index.IndexReader, bool, bool)</a> to create a matching <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> instance for a given <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_collector.html" title="Expert: Collectors are primarily meant to be used to gather raw results from a search, and implement sorting or custom result filtering, collation, etc. ">Collector</a>, or vice versa. <b>NOTE:</b> the default implementation returns <code>false</code>, i.e. the <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a></code> scores documents in-order. <a href="#ad298cceb7caae992cbc9770dc5891cf7"></a><br/></td></tr>
<tr class="separator:ad298cceb7caae992cbc9770dc5891cf7 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="memSeparator" colspan="2">&#160;</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:a2b30de71915f92d8ba5f0e6cd666c02a"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#a2b30de71915f92d8ba5f0e6cd666c02a">Query</a><code> [get]</code></td></tr>
<tr class="separator:a2b30de71915f92d8ba5f0e6cd666c02a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae27ba3bc4934f2d10de6b9c0fd77bdc7"><td class="memItemLeft" align="right" valign="top">override float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_weight.html#ae27ba3bc4934f2d10de6b9c0fd77bdc7">Value</a><code> [get]</code></td></tr>
<tr class="separator:ae27ba3bc4934f2d10de6b9c0fd77bdc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_weight"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_weight')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html">Lucene.Net.Search.Weight</a></td></tr>
<tr class="memitem:a3e631076861f54ae6f37a51d2b41fd26 inherit properties_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#a3e631076861f54ae6f37a51d2b41fd26">Query</a><code> [get]</code></td></tr>
<tr class="memdesc:a3e631076861f54ae6f37a51d2b41fd26 inherit properties_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="mdescLeft">&#160;</td><td class="mdescRight">The query that this concerns. <a href="#a3e631076861f54ae6f37a51d2b41fd26"></a><br/></td></tr>
<tr class="separator:a3e631076861f54ae6f37a51d2b41fd26 inherit properties_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c76b2c40a71faaa86352b5fe90a4bd0 inherit properties_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="memItemLeft" align="right" valign="top">abstract float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#a3c76b2c40a71faaa86352b5fe90a4bd0">Value</a><code> [get]</code></td></tr>
<tr class="memdesc:a3c76b2c40a71faaa86352b5fe90a4bd0 inherit properties_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="mdescLeft">&#160;</td><td class="mdescRight">The weight for this query. <a href="#a3c76b2c40a71faaa86352b5fe90a4bd0"></a><br/></td></tr>
<tr class="separator:a3c76b2c40a71faaa86352b5fe90a4bd0 inherit properties_class_lucene_1_1_net_1_1_search_1_1_weight"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Expert-only. Public for use by other weight implementations</p>
<p>Definition at line <a class="el" href="_span_weight_8cs_source.html#l00030">30</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a88c974b7d744936d0a229b5f67467767"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Spans.SpanWeight.SpanWeight </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_query.html">SpanQuery</a>&#160;</td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html">Searcher</a>&#160;</td>
<td class="paramname"><em>searcher</em>&#160;</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="_span_weight_8cs_source.html#l00042">42</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a65e4d9aa5279522c3c0a8486e544bd27"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a> Lucene.Net.Search.Spans.SpanWeight.Explain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>doc</em>&#160;</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>An explanation of the score computation for the named document. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>sub-reader containing the give doc </td></tr>
<tr><td class="paramname">doc</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html" title="Expert: Describes the score computation for document and query. ">Explanation</a> for the score </dd></dl>
<p>&lt;throws&gt; IOException &lt;/throws&gt; </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#a92fcb99f154bb5edd5ba363d3dab0b14">Lucene.Net.Search.Weight</a>.</p>
<p>Definition at line <a class="el" href="_span_weight_8cs_source.html#l00082">82</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aa8fe1b261bc9ba61ece412ad37b62af3"></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.Spans.SpanWeight.GetSumOfSquaredWeights </td>
<td>(</td>
<td class="paramname"></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>The sum of squared weights of contained query clauses. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#a0a9aa5e55306164f0b5e6b8ee30b8a41">Lucene.Net.Search.Weight</a>.</p>
<p>Definition at line <a class="el" href="_span_weight_8cs_source.html#l00064">64</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab834fae835530448639f6edd09fa80f3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Search.Spans.SpanWeight.Normalize </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>norm</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>Assigns the query normalization factor to this. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#a33ec760fdf31354a43b50d7abd53a573">Lucene.Net.Search.Weight</a>.</p>
<p>Definition at line <a class="el" href="_span_weight_8cs_source.html#l00070">70</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div>
</div>
<a class="anchor" id="acf28e7998b1ef802e2cfd8e61c261a35"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Scorer</a> Lucene.Net.Search.Spans.SpanWeight.Scorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>scoreDocsInOrder</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>topScorer</em>&#160;</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>Returns a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> which scores documents in/out-of order according to <code>scoreDocsInOrder</code>. <b>NOTE:</b> even if <code>scoreDocsInOrder</code> is false, it is recommended to check whether the returned <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a></code> indeed scores documents out of order (i.e., call <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#ad298cceb7caae992cbc9770dc5891cf7" title="Returns true iff this implementation scores docs only out of order. This method is used in conjunctio...">GetScoresDocsOutOfOrder()</a>), as some <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a></code> implementations will always return documents in-order.<br/>
<b>NOTE:</b> null can be returned if no documents will be scored by this query. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>the <a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> for which to return the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Lucene.Net.Search.Scorer</a>. </td></tr>
<tr><td class="paramname">scoreDocsInOrder</td><td>specifies whether in-order scoring of documents is required. Note that if set to false (i.e., out-of-order scoring is required), this method can return whatever scoring mode it supports, as every in-order scorer is also an out-of-order one. However, an out-of-order scorer may not support <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">DocIdSetIterator.NextDoc</a> and/or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">DocIdSetIterator.Advance(int)</a>, therefore it is recommended to request an in-order scorer if use of these methods is required. </td></tr>
<tr><td class="paramname">topScorer</td><td>if true, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html#a23e72c598a4e46bd528ed19b272fc687" title="Scores and collects all matching documents.">Lucene.Net.Search.Scorer.Score(Lucene.Net.Search.Collector)</a> will be called; if false, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">DocIdSetIterator.NextDoc</a> and/or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">DocIdSetIterator.Advance(int)</a> will be called. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> which scores documents in/out-of order. </dd></dl>
<p>&lt;throws&gt; IOException &lt;/throws&gt; </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html#a87064513b858e1608bf7c66731f89a6b">Lucene.Net.Search.Weight</a>.</p>
<p>Definition at line <a class="el" href="_span_weight_8cs_source.html#l00077">77</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a2b30de71915f92d8ba5f0e6cd666c02a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> Lucene.Net.Search.Spans.SpanWeight.Query</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_span_weight_8cs_source.html#l00055">55</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae27ba3bc4934f2d10de6b9c0fd77bdc7"></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.Spans.SpanWeight.Value</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_span_weight_8cs_source.html#l00060">60</a> of file <a class="el" href="_span_weight_8cs_source.html">SpanWeight.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Search/Spans/<a class="el" href="_span_weight_8cs_source.html">SpanWeight.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>