| <!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: contrib/Spatial/Queries/SpatialArgs.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 .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><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></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_3a8d697be1e2feab9f01acc78e9570fb.html">contrib</a></li><li class="navelem"><a class="el" href="dir_aa809726ac61f61d2abe128b5a67bd02.html">Spatial</a></li><li class="navelem"><a class="el" href="dir_64654364ecaabf7d6cb581a40fd3aa7e.html">Queries</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">SpatialArgs.cs</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_spatial_args_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> <span class="keyword">using</span> System.Text;</div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">using</span> Spatial4n.Core.Context;</div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">using</span> Spatial4n.Core.Exceptions;</div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">using</span> Spatial4n.Core.Shapes;</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="namespace_spatial4n_1_1_core_1_1_exceptions.html"> 24</a></span> <span class="keyword">namespace </span>Spatial4n.Core.Exceptions</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  [Serializable]</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"><a class="code" href="class_spatial4n_1_1_core_1_1_exceptions_1_1_invalid_spatial_argument.html"> 27</a></span>  <span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="class_spatial4n_1_1_core_1_1_exceptions_1_1_invalid_spatial_argument.html">InvalidSpatialArgument</a> : ArgumentException</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="class_spatial4n_1_1_core_1_1_exceptions_1_1_invalid_spatial_argument.html#af41e4574d5e72d8b97d585a8cee201de"> 29</a></span>  <span class="keyword">public</span> <a class="code" href="class_spatial4n_1_1_core_1_1_exceptions_1_1_invalid_spatial_argument.html">InvalidSpatialArgument</a>(String reason)</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  : base(reason)</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> }</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>Lucene.Net.Spatial.Queries</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="keyword">public</span> <span class="keyword">class </span>SpatialArgs</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span> <span class="keyword">static</span> readonly <span class="keywordtype">double</span> DEFAULT_DISTERRPCT = 0.025d;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">public</span> SpatialOperation Operation { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">public</span> SpatialArgs(SpatialOperation operation, Shape shape)</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  {</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">if</span> (operation == null || shape == null)</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentException(<span class="stringliteral">"operation and shape are required"</span>);</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  this.Operation = operation;</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  this.Shape = shape;</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">double</span> CalcDistanceFromErrPct(Shape shape, <span class="keywordtype">double</span> distErrPct, SpatialContext ctx)</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">if</span> (distErrPct < 0 || distErrPct > 0.5)</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentException(<span class="stringliteral">"distErrPct "</span> + distErrPct + <span class="stringliteral">" must be between [0 to 0.5]"</span>, <span class="stringliteral">"distErrPct"</span>);</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">if</span> (distErrPct == 0 || shape is Point)</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  {</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> 0;</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  Rectangle bbox = shape.GetBoundingBox();</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">//The diagonal distance should be the same computed from any opposite corner,</span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// and this is the longest distance that might be occurring within the shape.</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">double</span> diagonalDist = ctx.GetDistCalc().Distance(</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  ctx.MakePoint(bbox.GetMinX(), bbox.GetMinY()), bbox.GetMaxX(), bbox.GetMaxY());</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> diagonalDist*0.5*distErrPct;</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 class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">public</span> <span class="keywordtype">double</span> ResolveDistErr(SpatialContext ctx, <span class="keywordtype">double</span> defaultDistErrPct)</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">if</span> (DistErr != null)</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> DistErr.Value;</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">double</span>? distErrPct = (this.distErrPct ?? defaultDistErrPct);</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> CalcDistanceFromErrPct(Shape, distErrPct.Value, ctx);</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">public</span> <span class="keywordtype">void</span> Validate()</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  {</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">if</span> (Operation.IsTargetNeedsArea() && !Shape.HasArea())</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  {</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentException(Operation + <span class="stringliteral">" only supports geometry with area"</span>);</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">public</span> <span class="keyword">override</span> String ToString()</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  {</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">return</span> SpatialArgsParser.WriteSpatialArgs(<span class="keyword">this</span>);</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  }</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">//------------------------------------------------</span></div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// Getters & Setters</span></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">//------------------------------------------------</span></div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">public</span> Shape Shape { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">public</span> <span class="keywordtype">double</span>? DistErrPct</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  {</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">get</span> { <span class="keywordflow">return</span> distErrPct; }</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">set</span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  {</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">if</span> (value != null)</div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  distErrPct = value.Value;</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  }</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  }</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">private</span> <span class="keywordtype">double</span>? distErrPct;</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">public</span> <span class="keywordtype">double</span>? DistErr { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }</div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> }</div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:44 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> |
