Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_explanation.html
blob: 8a60889d3992d07c7cf6572b4815af32fa778edb [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.Explanation 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="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<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_explanation-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Explanation Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Expert: Describes the score computation for document and query.
<a href="class_lucene_1_1_net_1_1_search_1_1_explanation.html#details">More...</a></p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_complex_explanation.html">Lucene.Net.Search.ComplexExplanation</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation_1_1_i_d_f_explanation.html">IDFExplanation</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Small <a class="el" href="namespace_lucene_1_1_net_1_1_util.html">Util</a> class used to pass both an idf factor as well as an explanation for that factor. <a href="class_lucene_1_1_net_1_1_search_1_1_explanation_1_1_i_d_f_explanation.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a76ade3291458973f83aae1aaad291cc8"><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_explanation.html#a76ade3291458973f83aae1aaad291cc8">Explanation</a> ()</td></tr>
<tr class="separator:a76ade3291458973f83aae1aaad291cc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06ff69b3d9b33a6fe395cc85829b93be"><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_explanation.html#a06ff69b3d9b33a6fe395cc85829b93be">Explanation</a> (float value, System.String description)</td></tr>
<tr class="separator:a06ff69b3d9b33a6fe395cc85829b93be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a522ce9dd2caa9807b6c3879a96531234"><td class="memItemLeft" align="right" valign="top">virtual <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_explanation.html#a522ce9dd2caa9807b6c3879a96531234">GetDetails</a> ()</td></tr>
<tr class="memdesc:a522ce9dd2caa9807b6c3879a96531234"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sub-nodes of this explanation node. <a href="#a522ce9dd2caa9807b6c3879a96531234"></a><br/></td></tr>
<tr class="separator:a522ce9dd2caa9807b6c3879a96531234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61e84f9a277600115dbc3457ca276abd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html#a61e84f9a277600115dbc3457ca276abd">AddDetail</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a> detail)</td></tr>
<tr class="memdesc:a61e84f9a277600115dbc3457ca276abd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a sub-node to this explanation node. <a href="#a61e84f9a277600115dbc3457ca276abd"></a><br/></td></tr>
<tr class="separator:a61e84f9a277600115dbc3457ca276abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac44f14ca0acbb2c1e98f25667ecb52e4"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html#ac44f14ca0acbb2c1e98f25667ecb52e4">ToString</a> ()</td></tr>
<tr class="memdesc:ac44f14ca0acbb2c1e98f25667ecb52e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Render an explanation as text. <a href="#ac44f14ca0acbb2c1e98f25667ecb52e4"></a><br/></td></tr>
<tr class="separator:ac44f14ca0acbb2c1e98f25667ecb52e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36e27891fd74f20dd4c9621fc5345a27"><td class="memItemLeft" align="right" valign="top">virtual System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html#a36e27891fd74f20dd4c9621fc5345a27">ToHtml</a> ()</td></tr>
<tr class="memdesc:a36e27891fd74f20dd4c9621fc5345a27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Render an explanation as HTML. <a href="#a36e27891fd74f20dd4c9621fc5345a27"></a><br/></td></tr>
<tr class="separator:a36e27891fd74f20dd4c9621fc5345a27"><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:a67c3152297c3f704820b3a0de8ad8a52"><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_explanation.html#a67c3152297c3f704820b3a0de8ad8a52">IsMatch</a><code> [get]</code></td></tr>
<tr class="memdesc:a67c3152297c3f704820b3a0de8ad8a52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not this <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> models a good match. <a href="#a67c3152297c3f704820b3a0de8ad8a52"></a><br/></td></tr>
<tr class="separator:a67c3152297c3f704820b3a0de8ad8a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7933fa7759da03b13211cf2804c40af"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html#ae7933fa7759da03b13211cf2804c40af">Value</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ae7933fa7759da03b13211cf2804c40af"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value assigned to this explanation node. <a href="#ae7933fa7759da03b13211cf2804c40af"></a><br/></td></tr>
<tr class="separator:ae7933fa7759da03b13211cf2804c40af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ea561368bd5826af73342c3fe2e5eb5"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html#a6ea561368bd5826af73342c3fe2e5eb5">Description</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a6ea561368bd5826af73342c3fe2e5eb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">A description of this explanation node. <a href="#a6ea561368bd5826af73342c3fe2e5eb5"></a><br/></td></tr>
<tr class="separator:a6ea561368bd5826af73342c3fe2e5eb5"><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: Describes the score computation for document and query. </p>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00026">26</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a76ade3291458973f83aae1aaad291cc8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Explanation.Explanation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00032">32</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a06ff69b3d9b33a6fe395cc85829b93be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Explanation.Explanation </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>description</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="_explanation_8cs_source.html#l00036">36</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a61e84f9a277600115dbc3457ca276abd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Search.Explanation.AddDetail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a>&#160;</td>
<td class="paramname"><em>detail</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>Adds a sub-node to this explanation node. </p>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00087">87</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a522ce9dd2caa9807b6c3879a96531234"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html">Explanation</a> [] Lucene.Net.Search.Explanation.GetDetails </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 sub-nodes of this explanation node. </p>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00079">79</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a36e27891fd74f20dd4c9621fc5345a27"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual System.String Lucene.Net.Search.Explanation.ToHtml </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>Render an explanation as HTML. </p>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00123">123</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ac44f14ca0acbb2c1e98f25667ecb52e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Search.Explanation.ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Render an explanation as text. </p>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00095">95</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a6ea561368bd5826af73342c3fe2e5eb5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual string Lucene.Net.Search.Explanation.Description</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A description of this explanation node. </p>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00065">65</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a67c3152297c3f704820b3a0de8ad8a52"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Lucene.Net.Search.Explanation.IsMatch</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>Indicates whether or not this <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> models a good match. </p>
<p>By default, 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> represents a "match" if the value is positive. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_explanation.html#ae7933fa7759da03b13211cf2804c40af" title="The value assigned to this explanation node. ">Value</a></dd></dl>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00051">51</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae7933fa7759da03b13211cf2804c40af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float Lucene.Net.Search.Explanation.Value</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The value assigned to this explanation node. </p>
<p>Definition at line <a class="el" href="_explanation_8cs_source.html#l00058">58</a> of file <a class="el" href="_explanation_8cs_source.html">Explanation.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="_explanation_8cs_source.html">Explanation.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:56 for Lucene.Net by &#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>