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
|
<!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.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::GreatCircleMetric 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.22</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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_1GreatCircleMetric.html">GreatCircleMetric</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1GreatCircleMetric-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Xapian::GreatCircleMetric Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Calculate the great-circle distance between two coordinates on a sphere.
<a href="classXapian_1_1GreatCircleMetric.html#details">More...</a></p>
<p><code>#include <geospatial.h></code></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::GreatCircleMetric:</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_1GreatCircleMetric__inherit__graph.png" border="0" usemap="#aXapian_1_1GreatCircleMetric_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1GreatCircleMetric_inherit__map" id="aXapian_1_1GreatCircleMetric_inherit__map">
<area shape="rect" title="Calculate the great-circle distance between two coordinates on a sphere." alt="" coords="5,80,195,107"/>
<area shape="rect" href="classXapian_1_1LatLongMetric.html" title="Base class for calculating distances between two lat/long coordinates." alt="" coords="17,5,183,32"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a370614b3184b248cef3466360a306f04"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1GreatCircleMetric.html#a370614b3184b248cef3466360a306f04">GreatCircleMetric</a> ()</td></tr>
<tr class="memdesc:a370614b3184b248cef3466360a306f04"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1GreatCircleMetric.html" title="Calculate the great-circle distance between two coordinates on a sphere.">GreatCircleMetric</a>. <a href="classXapian_1_1GreatCircleMetric.html#a370614b3184b248cef3466360a306f04">More...</a><br /></td></tr>
<tr class="separator:a370614b3184b248cef3466360a306f04"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1503db5015359efd5045947d249773a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1GreatCircleMetric.html#ad1503db5015359efd5045947d249773a">GreatCircleMetric</a> (double radius_)</td></tr>
<tr class="memdesc:ad1503db5015359efd5045947d249773a"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1GreatCircleMetric.html" title="Calculate the great-circle distance between two coordinates on a sphere.">GreatCircleMetric</a> using a specified radius. <a href="classXapian_1_1GreatCircleMetric.html#ad1503db5015359efd5045947d249773a">More...</a><br /></td></tr>
<tr class="separator:ad1503db5015359efd5045947d249773a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc3ebef50fda81a5fc70bf666098bbb5"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1GreatCircleMetric.html#afc3ebef50fda81a5fc70bf666098bbb5">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</td></tr>
<tr class="memdesc:afc3ebef50fda81a5fc70bf666098bbb5"><td class="mdescLeft"> </td><td class="mdescRight">Return the great-circle distance between points on the sphere. <a href="classXapian_1_1GreatCircleMetric.html#afc3ebef50fda81a5fc70bf666098bbb5">More...</a><br /></td></tr>
<tr class="separator:afc3ebef50fda81a5fc70bf666098bbb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a9a960564bccae8c449a06691feed9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1GreatCircleMetric.html#a3a9a960564bccae8c449a06691feed9e">clone</a> () const</td></tr>
<tr class="memdesc:a3a9a960564bccae8c449a06691feed9e"><td class="mdescLeft"> </td><td class="mdescRight">Clone the metric. <a href="classXapian_1_1GreatCircleMetric.html#a3a9a960564bccae8c449a06691feed9e">More...</a><br /></td></tr>
<tr class="separator:a3a9a960564bccae8c449a06691feed9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae714ff4dc3aa8cb176007f6696b6cba4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1GreatCircleMetric.html#ae714ff4dc3aa8cb176007f6696b6cba4">name</a> () const</td></tr>
<tr class="memdesc:ae714ff4dc3aa8cb176007f6696b6cba4"><td class="mdescLeft"> </td><td class="mdescRight">Return the full name of the metric. <a href="classXapian_1_1GreatCircleMetric.html#ae714ff4dc3aa8cb176007f6696b6cba4">More...</a><br /></td></tr>
<tr class="separator:ae714ff4dc3aa8cb176007f6696b6cba4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c59f816fdee553ee213693cd037657a"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1GreatCircleMetric.html#a2c59f816fdee553ee213693cd037657a">serialise</a> () const</td></tr>
<tr class="memdesc:a2c59f816fdee553ee213693cd037657a"><td class="mdescLeft"> </td><td class="mdescRight">Serialise object parameters into a string. <a href="classXapian_1_1GreatCircleMetric.html#a2c59f816fdee553ee213693cd037657a">More...</a><br /></td></tr>
<tr class="separator:a2c59f816fdee553ee213693cd037657a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5d72e63be8e63f83d2d089335810d68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1GreatCircleMetric.html#ad5d72e63be8e63f83d2d089335810d68">unserialise</a> (const std::string &serialised) const</td></tr>
<tr class="memdesc:ad5d72e63be8e63f83d2d089335810d68"><td class="mdescLeft"> </td><td class="mdescRight">Create object given string serialisation returned by <a class="el" href="classXapian_1_1GreatCircleMetric.html#a2c59f816fdee553ee213693cd037657a" title="Serialise object parameters into a string.">serialise()</a>. <a href="classXapian_1_1GreatCircleMetric.html#ad5d72e63be8e63f83d2d089335810d68">More...</a><br /></td></tr>
<tr class="separator:ad5d72e63be8e63f83d2d089335810d68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1LatLongMetric"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1LatLongMetric')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1LatLongMetric.html">Xapian::LatLongMetric</a></td></tr>
<tr class="memitem:a43dd8ae5b17c70310f3581fb7dabbca6 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memItemLeft" align="right" valign="top"><a id="a43dd8ae5b17c70310f3581fb7dabbca6" name="a43dd8ae5b17c70310f3581fb7dabbca6"></a>
virtual </td><td class="memItemRight" valign="bottom"><b>~LatLongMetric</b> ()</td></tr>
<tr class="memdesc:a43dd8ae5b17c70310f3581fb7dabbca6 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a43dd8ae5b17c70310f3581fb7dabbca6 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86f171d4bac6e0ceaed163f72b91ec09 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memItemLeft" align="right" valign="top">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 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance between two coordinates, in metres. <a href="classXapian_1_1LatLongMetric.html#a86f171d4bac6e0ceaed163f72b91ec09">More...</a><br /></td></tr>
<tr class="separator:a86f171d4bac6e0ceaed163f72b91ec09 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12f867071c2715dabef83ea7fb9e9768 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9d8ef2fae8e873260152117cea235fc inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d61e659ded795c9f9b58eb317264db3 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afaa1bd4b60c13a1331924cf72381afa0 inherit pub_methods_classXapian_1_1LatLongMetric"><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#afaa1bd4b60c13a1331924cf72381afa0">clone</a> () const =0</td></tr>
<tr class="memdesc:afaa1bd4b60c13a1331924cf72381afa0 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="mdescLeft"> </td><td class="mdescRight">Clone the metric. <a href="classXapian_1_1LatLongMetric.html#afaa1bd4b60c13a1331924cf72381afa0">More...</a><br /></td></tr>
<tr class="separator:afaa1bd4b60c13a1331924cf72381afa0 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea76cb50cc44dea3aa24833576bdaa9e inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1d46b882a7878228ffd6e0f574f3ad5 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><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 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7174d85406e1e6a8164cd39262390b8 inherit pub_methods_classXapian_1_1LatLongMetric"><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#ad7174d85406e1e6a8164cd39262390b8">unserialise</a> (const std::string &serialised) const =0</td></tr>
<tr class="memdesc:ad7174d85406e1e6a8164cd39262390b8 inherit pub_methods_classXapian_1_1LatLongMetric"><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#ad7174d85406e1e6a8164cd39262390b8">More...</a><br /></td></tr>
<tr class="separator:ad7174d85406e1e6a8164cd39262390b8 inherit pub_methods_classXapian_1_1LatLongMetric"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Calculate the great-circle distance between two coordinates on a sphere. </p>
<p >Experimental - see <a href="https://xapian.org/docs/deprecation#experimental-features">https://xapian.org/docs/deprecation#experimental-features</a></p>
<p >This uses the haversine formula to calculate the distance. Note that this formula is subject to inaccuracy due to numerical errors for coordinates on the opposite side of the sphere.</p>
<p >See <a href="https://en.wikipedia.org/wiki/Haversine_formula">https://en.wikipedia.org/wiki/Haversine_formula</a> </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a370614b3184b248cef3466360a306f04" name="a370614b3184b248cef3466360a306f04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a370614b3184b248cef3466360a306f04">◆ </a></span>GreatCircleMetric() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::GreatCircleMetric::GreatCircleMetric </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1GreatCircleMetric.html" title="Calculate the great-circle distance between two coordinates on a sphere.">GreatCircleMetric</a>. </p>
<p >The (quadratic mean) radius of the Earth will be used by this calculator. </p>
</div>
</div>
<a id="ad1503db5015359efd5045947d249773a" name="ad1503db5015359efd5045947d249773a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1503db5015359efd5045947d249773a">◆ </a></span>GreatCircleMetric() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::GreatCircleMetric::GreatCircleMetric </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>radius_</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1GreatCircleMetric.html" title="Calculate the great-circle distance between two coordinates on a sphere.">GreatCircleMetric</a> using a specified radius. </p>
<p >This is useful for data sets in which the points are not on Earth (eg, a database of features on Mars).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">radius_</td><td>The radius of the sphere to use, in metres. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3a9a960564bccae8c449a06691feed9e" name="a3a9a960564bccae8c449a06691feed9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a9a960564bccae8c449a06691feed9e">◆ </a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> * Xapian::GreatCircleMetric::clone </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone the metric. </p>
<p>Implements <a class="el" href="classXapian_1_1LatLongMetric.html#afaa1bd4b60c13a1331924cf72381afa0">Xapian::LatLongMetric</a>.</p>
</div>
</div>
<a id="ae714ff4dc3aa8cb176007f6696b6cba4" name="ae714ff4dc3aa8cb176007f6696b6cba4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae714ff4dc3aa8cb176007f6696b6cba4">◆ </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">std::string Xapian::GreatCircleMetric::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">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>Implements <a class="el" href="classXapian_1_1LatLongMetric.html#aea76cb50cc44dea3aa24833576bdaa9e">Xapian::LatLongMetric</a>.</p>
</div>
</div>
<a id="afc3ebef50fda81a5fc70bf666098bbb5" name="afc3ebef50fda81a5fc70bf666098bbb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc3ebef50fda81a5fc70bf666098bbb5">◆ </a></span>pointwise_distance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Xapian::GreatCircleMetric::pointwise_distance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</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="structXapian_1_1LatLongCoord.html">LatLongCoord</a> & </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the great-circle distance between points on the sphere. </p>
<p>Implements <a class="el" href="classXapian_1_1LatLongMetric.html#a86f171d4bac6e0ceaed163f72b91ec09">Xapian::LatLongMetric</a>.</p>
</div>
</div>
<a id="a2c59f816fdee553ee213693cd037657a" name="a2c59f816fdee553ee213693cd037657a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c59f816fdee553ee213693cd037657a">◆ </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">std::string Xapian::GreatCircleMetric::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">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>Implements <a class="el" href="classXapian_1_1LatLongMetric.html#ac1d46b882a7878228ffd6e0f574f3ad5">Xapian::LatLongMetric</a>.</p>
</div>
</div>
<a id="ad5d72e63be8e63f83d2d089335810d68" name="ad5d72e63be8e63f83d2d089335810d68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5d72e63be8e63f83d2d089335810d68">◆ </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"><a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> * Xapian::GreatCircleMetric::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create object given string serialisation returned by <a class="el" href="classXapian_1_1GreatCircleMetric.html#a2c59f816fdee553ee213693cd037657a" 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>Implements <a class="el" href="classXapian_1_1LatLongMetric.html#ad7174d85406e1e6a8164cd39262390b8">Xapian::LatLongMetric</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.4</a>
</small></address>
</body>
</html>
|
