1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::LatLongMetric 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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">xapian-core
 <span id="projectnumber">1.4.18</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1LatLongMetric-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::LatLongMetric Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for calculating distances between two lat/long coordinates.
<a href="classXapian_1_1LatLongMetric.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::LatLongMetric:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classXapian_1_1LatLongMetric__inherit__graph.png" border="0" usemap="#aXapian_1_1LatLongMetric_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1LatLongMetric_inherit__map" id="aXapian_1_1LatLongMetric_inherit__map">
<area shape="rect" title="Base class for calculating distances between two lat/long coordinates." alt="" coords="17,5,183,32"/>
<area shape="rect" href="classXapian_1_1GreatCircleMetric.html" title="Calculate the great-circle distance between two coordinates on a sphere." alt="" coords="5,80,195,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a43dd8ae5b17c70310f3581fb7dabbca6"><td class="memItemLeft" align="right" valign="top"><a id="a43dd8ae5b17c70310f3581fb7dabbca6"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#a43dd8ae5b17c70310f3581fb7dabbca6">~LatLongMetric</a> ()</td></tr>
<tr class="memdesc:a43dd8ae5b17c70310f3581fb7dabbca6"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a43dd8ae5b17c70310f3581fb7dabbca6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86f171d4bac6e0ceaed163f72b91ec09"><td class="memItemLeft" align="right" valign="top"><a id="a86f171d4bac6e0ceaed163f72b91ec09"></a>
virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#a86f171d4bac6e0ceaed163f72b91ec09">pointwise_distance</a> (const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &a, const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &b) const =0</td></tr>
<tr class="memdesc:a86f171d4bac6e0ceaed163f72b91ec09"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance between two coordinates, in metres. <br /></td></tr>
<tr class="separator:a86f171d4bac6e0ceaed163f72b91ec09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12f867071c2715dabef83ea7fb9e9768"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#a12f867071c2715dabef83ea7fb9e9768">operator()</a> (const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &a, const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &b) const</td></tr>
<tr class="memdesc:a12f867071c2715dabef83ea7fb9e9768"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance between two coordinate lists, in metres. <a href="classXapian_1_1LatLongMetric.html#a12f867071c2715dabef83ea7fb9e9768">More...</a><br /></td></tr>
<tr class="separator:a12f867071c2715dabef83ea7fb9e9768"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9d8ef2fae8e873260152117cea235fc"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#ad9d8ef2fae8e873260152117cea235fc">operator()</a> (const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &a, const std::string &b) const</td></tr>
<tr class="memdesc:ad9d8ef2fae8e873260152117cea235fc"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance between two coordinate lists, in metres. <a href="classXapian_1_1LatLongMetric.html#ad9d8ef2fae8e873260152117cea235fc">More...</a><br /></td></tr>
<tr class="separator:ad9d8ef2fae8e873260152117cea235fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d61e659ded795c9f9b58eb317264db3"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#a2d61e659ded795c9f9b58eb317264db3">operator()</a> (const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &a, const char *b_ptr, size_t b_len) const</td></tr>
<tr class="memdesc:a2d61e659ded795c9f9b58eb317264db3"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance between two coordinate lists, in metres. <a href="classXapian_1_1LatLongMetric.html#a2d61e659ded795c9f9b58eb317264db3">More...</a><br /></td></tr>
<tr class="separator:a2d61e659ded795c9f9b58eb317264db3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae57851d77d55fc6614a2c54fc4f27dfe"><td class="memItemLeft" align="right" valign="top"><a id="ae57851d77d55fc6614a2c54fc4f27dfe"></a>
virtual <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#ae57851d77d55fc6614a2c54fc4f27dfe">clone</a> () const =0</td></tr>
<tr class="memdesc:ae57851d77d55fc6614a2c54fc4f27dfe"><td class="mdescLeft"> </td><td class="mdescRight">Clone the metric. <br /></td></tr>
<tr class="separator:ae57851d77d55fc6614a2c54fc4f27dfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea76cb50cc44dea3aa24833576bdaa9e"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#aea76cb50cc44dea3aa24833576bdaa9e">name</a> () const =0</td></tr>
<tr class="memdesc:aea76cb50cc44dea3aa24833576bdaa9e"><td class="mdescLeft"> </td><td class="mdescRight">Return the full name of the metric. <a href="classXapian_1_1LatLongMetric.html#aea76cb50cc44dea3aa24833576bdaa9e">More...</a><br /></td></tr>
<tr class="separator:aea76cb50cc44dea3aa24833576bdaa9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1d46b882a7878228ffd6e0f574f3ad5"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#ac1d46b882a7878228ffd6e0f574f3ad5">serialise</a> () const =0</td></tr>
<tr class="memdesc:ac1d46b882a7878228ffd6e0f574f3ad5"><td class="mdescLeft"> </td><td class="mdescRight">Serialise object parameters into a string. <a href="classXapian_1_1LatLongMetric.html#ac1d46b882a7878228ffd6e0f574f3ad5">More...</a><br /></td></tr>
<tr class="separator:ac1d46b882a7878228ffd6e0f574f3ad5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe711103b15df59169811c5c0bc99063"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1LatLongMetric.html#abe711103b15df59169811c5c0bc99063">unserialise</a> (const std::string &serialised) const =0</td></tr>
<tr class="memdesc:abe711103b15df59169811c5c0bc99063"><td class="mdescLeft"> </td><td class="mdescRight">Create object given string serialisation returned by <a class="el" href="classXapian_1_1LatLongMetric.html#ac1d46b882a7878228ffd6e0f574f3ad5" title="Serialise object parameters into a string.">serialise()</a>. <a href="classXapian_1_1LatLongMetric.html#abe711103b15df59169811c5c0bc99063">More...</a><br /></td></tr>
<tr class="separator:abe711103b15df59169811c5c0bc99063"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for calculating distances between two lat/long coordinates. </p>
<p>Experimental - see <a href="https://xapian.org/docs/deprecation#experimental-features">https://xapian.org/docs/deprecation#experimental-features</a> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aea76cb50cc44dea3aa24833576bdaa9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea76cb50cc44dea3aa24833576bdaa9e">◆ </a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::LatLongMetric::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the full name of the metric. </p>
<p>This is used when serialising and unserialising metrics; for example, for performing remote searches.</p>
<p>If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a <a class="el" href="classXapian_1_1LatLongMetric.html" title="Base class for calculating distances between two lat/long coordinates.">LatLongMetric</a> subclass called "FooLatLongMetric" in the "Xapian" namespace the result of this call should be "Xapian::FooLatLongMetric". </p>
<p>Implemented in <a class="el" href="classXapian_1_1GreatCircleMetric.html#ae714ff4dc3aa8cb176007f6696b6cba4">Xapian::GreatCircleMetric</a>.</p>
</div>
</div>
<a id="a2d61e659ded795c9f9b58eb317264db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d61e659ded795c9f9b58eb317264db3">◆ </a></span>operator()() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Xapian::LatLongMetric::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>b_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>b_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the distance between two coordinate lists, in metres. </p>
<p>One of the coordinate lists is supplied in serialised form.</p>
<p>The distance between the coordinate lists is defined to be the minimum pairwise distance between coordinates in the lists.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">InvalidArgumentError</a></td><td>either of the lists is empty.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>The first coordinate list. </td></tr>
<tr><td class="paramname">b_ptr</td><td>The start of the serialised form of the second coordinate list. </td></tr>
<tr><td class="paramname">b_len</td><td>The length of the serialised form of the second coordinate list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a12f867071c2715dabef83ea7fb9e9768"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12f867071c2715dabef83ea7fb9e9768">◆ </a></span>operator()() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Xapian::LatLongMetric::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the distance between two coordinate lists, in metres. </p>
<p>The distance between the coordinate lists is defined to be the minimum pairwise distance between coordinates in the lists.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">InvalidArgumentError</a></td><td>either of the lists is empty.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>The first coordinate list. </td></tr>
<tr><td class="paramname">b</td><td>The second coordinate list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad9d8ef2fae8e873260152117cea235fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9d8ef2fae8e873260152117cea235fc">◆ </a></span>operator()() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Xapian::LatLongMetric::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> & </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the distance between two coordinate lists, in metres. </p>
<p>One of the coordinate lists is supplied in serialised form.</p>
<p>The distance between the coordinate lists is defined to be the minimum pairwise distance between coordinates in the lists.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API.">InvalidArgumentError</a></td><td>either of the lists is empty.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>The first coordinate list. </td></tr>
<tr><td class="paramname">b</td><td>The second coordinate list, in serialised form. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="classXapian_1_1LatLongCoords.html#a2cfcb41799e6e9e43454d5a253b164aa">Xapian::LatLongCoords::size()</a>.</p>
</div>
</div>
<a id="ac1d46b882a7878228ffd6e0f574f3ad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1d46b882a7878228ffd6e0f574f3ad5">◆ </a></span>serialise()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string Xapian::LatLongMetric::serialise </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialise object parameters into a string. </p>
<p>The serialised parameters should represent the configuration of the metric. </p>
<p>Implemented in <a class="el" href="classXapian_1_1GreatCircleMetric.html#a2c59f816fdee553ee213693cd037657a">Xapian::GreatCircleMetric</a>.</p>
</div>
</div>
<a id="abe711103b15df59169811c5c0bc99063"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe711103b15df59169811c5c0bc99063">◆ </a></span>unserialise()</h2>
<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="classXapian_1_1LatLongMetric.html">LatLongMetric</a>* Xapian::LatLongMetric::unserialise </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>serialised</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create object given string serialisation returned by <a class="el" href="classXapian_1_1LatLongMetric.html#ac1d46b882a7878228ffd6e0f574f3ad5" title="Serialise object parameters into a string.">serialise()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">serialised</td><td>A serialised instance of this <a class="el" href="classXapian_1_1LatLongMetric.html" title="Base class for calculating distances between two lat/long coordinates.">LatLongMetric</a> subclass. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classXapian_1_1GreatCircleMetric.html#ac984948151a8b6bd4741f3692c5988ca">Xapian::GreatCircleMetric</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="geospatial_8h.html">geospatial.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.1</a>
</small></address>
</body>
</html>
|