| <!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.Spatial.BBox.BBoxSimilarityValueSource 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_spatial.html">Spatial</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_spatial_1_1_b_box.html">BBox</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity_value_source.html">BBoxSimilarityValueSource</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity_value_source-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html">Lucene.Net.Search.Function.ValueSource</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:a3749f1a115bc71015eb2b631c9e69020"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity_value_source.html#a3749f1a115bc71015eb2b631c9e69020">BBoxSimilarityValueSource</a> (<a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_strategy.html">BBoxStrategy</a> strategy, <a class="el" href="interface_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity.html">BBoxSimilarity</a> similarity)</td></tr> |
| <tr class="separator:a3749f1a115bc71015eb2b631c9e69020"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e628e85acf8ef386f34f74e15c9dd26"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html">DocValues</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity_value_source.html#a4e628e85acf8ef386f34f74e15c9dd26">GetValues</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader)</td></tr> |
| <tr class="memdesc:a4e628e85acf8ef386f34f74e15c9dd26"><td class="mdescLeft"> </td><td class="mdescRight">Return the DocValues used by the function query. <a href="#a4e628e85acf8ef386f34f74e15c9dd26"></a><br/></td></tr> |
| <tr class="separator:a4e628e85acf8ef386f34f74e15c9dd26"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad35208e7adb9edddc2357b5ccc32a875"><td class="memItemLeft" align="right" valign="top">override string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity_value_source.html#ad35208e7adb9edddc2357b5ccc32a875">Description</a> ()</td></tr> |
| <tr class="memdesc:ad35208e7adb9edddc2357b5ccc32a875"><td class="mdescLeft"> </td><td class="mdescRight">description of field, used in explain() <a href="#ad35208e7adb9edddc2357b5ccc32a875"></a><br/></td></tr> |
| <tr class="separator:ad35208e7adb9edddc2357b5ccc32a875"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a097835730c2739909ad798665b13261f"><td class="memItemLeft" align="right" valign="top">override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity_value_source.html#a097835730c2739909ad798665b13261f">Equals</a> (object o)</td></tr> |
| <tr class="separator:a097835730c2739909ad798665b13261f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad2ad6e1a046b4dd4c90f8d890cdd8c69"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity_value_source.html#ad2ad6e1a046b4dd4c90f8d890cdd8c69">GetHashCode</a> ()</td></tr> |
| <tr class="memdesc:ad2ad6e1a046b4dd4c90f8d890cdd8c69"><td class="mdescLeft"> </td><td class="mdescRight">Needed for possible caching of query results - used by ValueSourceQuery.GetHashCode(). <a href="#ad2ad6e1a046b4dd4c90f8d890cdd8c69"></a><br/></td></tr> |
| <tr class="separator:ad2ad6e1a046b4dd4c90f8d890cdd8c69"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html">Lucene.Net.Search.Function.ValueSource</a></td></tr> |
| <tr class="memitem:a502b061330d9e0ba6139ac58a4ffa0b9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a502b061330d9e0ba6139ac58a4ffa0b9">ToString</a> ()</td></tr> |
| <tr class="separator:a502b061330d9e0ba6139ac58a4ffa0b9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed70eaaa40d4170914f814a7ced188bc inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><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_function_1_1_value_source.html#aed70eaaa40d4170914f814a7ced188bc">Equals</a> (System.Object o)</td></tr> |
| <tr class="memdesc:aed70eaaa40d4170914f814a7ced188bc inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="mdescLeft"> </td><td class="mdescRight">Needed for possible caching of query results - used by ValueSourceQuery.Equals(Object). <a href="#aed70eaaa40d4170914f814a7ced188bc"></a><br/></td></tr> |
| <tr class="separator:aed70eaaa40d4170914f814a7ced188bc inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"> |
| <p>Definition at line <a class="el" href="_b_box_similarity_value_source_8cs_source.html#l00027">27</a> of file <a class="el" href="_b_box_similarity_value_source_8cs_source.html">BBoxSimilarityValueSource.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a3749f1a115bc71015eb2b631c9e69020"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource.BBoxSimilarityValueSource </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_strategy.html">BBoxStrategy</a> </td> |
| <td class="paramname"><em>strategy</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_spatial_1_1_b_box_1_1_b_box_similarity.html">BBoxSimilarity</a> </td> |
| <td class="paramname"><em>similarity</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="_b_box_similarity_value_source_8cs_source.html#l00032">32</a> of file <a class="el" href="_b_box_similarity_value_source_8cs_source.html">BBoxSimilarityValueSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ad35208e7adb9edddc2357b5ccc32a875"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override string Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource.Description </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>description of field, used in explain() </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a20134fc1e0bb7739626e2434f95473ba">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_b_box_similarity_value_source_8cs_source.html#l00105">105</a> of file <a class="el" href="_b_box_similarity_value_source_8cs_source.html">BBoxSimilarityValueSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a097835730c2739909ad798665b13261f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override bool Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource.Equals </td> |
| <td>(</td> |
| <td class="paramtype">object </td> |
| <td class="paramname"><em>o</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_b_box_similarity_value_source_8cs_source.html#l00110">110</a> of file <a class="el" href="_b_box_similarity_value_source_8cs_source.html">BBoxSimilarityValueSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad2ad6e1a046b4dd4c90f8d890cdd8c69"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource.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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Needed for possible caching of query results - used by ValueSourceQuery.GetHashCode().</p> |
| <dl class="section see"><dt>See Also</dt><dd>Object.GetHashCode()</dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a614e97264e961aa7c769a6e592f30f09">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_b_box_similarity_value_source_8cs_source.html#l00117">117</a> of file <a class="el" href="_b_box_similarity_value_source_8cs_source.html">BBoxSimilarityValueSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4e628e85acf8ef386f34f74e15c9dd26"></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_function_1_1_doc_values.html">DocValues</a> Lucene.Net.Spatial.BBox.BBoxSimilarityValueSource.GetValues </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> </td> |
| <td class="paramname"><em>reader</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>Return the DocValues used by the function query.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>the IndexReader used to read these values. If any caching is involved, that caching would also be IndexReader based. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IOException for any error. </throws> </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a4fe47158939f191400db3b71dec5a61f">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_b_box_similarity_value_source_8cs_source.html#l00100">100</a> of file <a class="el" href="_b_box_similarity_value_source_8cs_source.html">BBoxSimilarityValueSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/Spatial/BBox/<a class="el" href="_b_box_similarity_value_source_8cs_source.html">BBoxSimilarityValueSource.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> |