Debian Codegraph @

docs/apidoc/html/classXapian_1_1LatLongDistanceKeyMaker.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.15.0"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Xapian: API Documentation: Xapian::LatLongDistanceKeyMaker Class Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18 <tbody>
19 <tr style="height: 56px;">
20 <td id="projectalign" style="padding-left: 0.5em;">
21 <div id="projectname">xapian-core
22 &#160;<span id="projectnumber">1.4.31</span>
23 </div>
24 </td>
25 </tr>
26 </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.15.0 -->
31 <script type="text/javascript">
32 $(function() { codefold.init(); });
33 </script>
34 <script type="text/javascript" src="menudata.js"></script>
35 <script type="text/javascript" src="menu.js"></script>
36 <script type="text/javascript">
37 $(function() {
38 initMenu('',false,false,'search.php','Search',false);
39 });
40 </script>
41 <div id="main-nav"></div>
42 <div id="nav-path" class="navpath">
43 <ul>
44 <li class="navelem"><a href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a href="classXapian_1_1LatLongDistanceKeyMaker.html">LatLongDistanceKeyMaker</a></li> </ul>
45 </div>
46 </div><!-- top -->
47 <div id="doc-content">
48 <div class="header">
49 <div class="summary">
50 <a href="#pub-methods">Public Member Functions</a> &#124;
51 <a href="classXapian_1_1LatLongDistanceKeyMaker-members.html">List of all members</a> </div>
52 <div class="headertitle"><div class="title">Xapian::LatLongDistanceKeyMaker Class Reference</div></div>
53 </div><!--header-->
54 <div class="contents">
55
56 <p><a class="el" href="classXapian_1_1KeyMaker.html" title="Virtual base class for key making functors.">KeyMaker</a> subclass which sorts by distance from a latitude/longitude.
57 <a href="#details">More...</a></p>
58
59 <p><code>#include &lt;geospatial.h&gt;</code></p>
60 <div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Inheritance diagram for Xapian::LatLongDistanceKeyMaker:</div>
61 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
62 </div>
63 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
64 <div class="center"><img src="classXapian_1_1LatLongDistanceKeyMaker__inherit__graph.png" border="0" usemap="#aXapian_1_1LatLongDistanceKeyMaker_inherit__map" loading="lazy" alt="Inheritance graph"/></div>
65 <map name="aXapian_1_1LatLongDistanceKeyMaker_inherit__map" id="aXapian_1_1LatLongDistanceKeyMaker_inherit__map">
66 <area shape="rect" title="KeyMaker subclass which sorts by distance from a latitude/longitude." alt="" coords="5,174,212,218"/>
67 <area shape="rect" href="classXapian_1_1KeyMaker.html" title="Virtual base class for key making functors." alt="" coords="39,98,178,126"/>
68 <area shape="poly" title=" " alt="" coords="110,140,111,174,106,172,107,144"/>
69 <area shape="rect" title=" " alt="" coords="32,5,185,50"/>
70 <area shape="poly" title=" " alt="" coords="110,63,111,98,106,97,107,68"/>
71 </map>
72 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
73 <table class="memberdecls">
74 <tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
75 Public Member Functions</h2></td></tr>
76 <tr class="memitem:a18ec53fcc714fe0de6ca23df4ca18d3e" id="r_a18ec53fcc714fe0de6ca23df4ca18d3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18ec53fcc714fe0de6ca23df4ca18d3e">LatLongDistanceKeyMaker</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &amp;centre_, const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;metric_, double defdistance)</td></tr>
77 <tr class="memdesc:a18ec53fcc714fe0de6ca23df4ca18d3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. <br /></td></tr>
78 <tr class="memitem:aac32f708de1e9743834cec4d93d9b293" id="r_aac32f708de1e9743834cec4d93d9b293"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aac32f708de1e9743834cec4d93d9b293">LatLongDistanceKeyMaker</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &amp;centre_, const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;metric_)</td></tr>
79 <tr class="memdesc:aac32f708de1e9743834cec4d93d9b293"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. <br /></td></tr>
80 <tr class="memitem:a73769e54aadb7cf340ee74de68666814" id="r_a73769e54aadb7cf340ee74de68666814"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73769e54aadb7cf340ee74de68666814">LatLongDistanceKeyMaker</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &amp;centre_)</td></tr>
81 <tr class="memdesc:a73769e54aadb7cf340ee74de68666814"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. <br /></td></tr>
82 <tr class="memitem:aaa237f65e70a244c74a56ef73ca778ed" id="r_aaa237f65e70a244c74a56ef73ca778ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa237f65e70a244c74a56ef73ca778ed">LatLongDistanceKeyMaker</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;centre_, const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;metric_, double defdistance)</td></tr>
83 <tr class="memdesc:aaa237f65e70a244c74a56ef73ca778ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. <br /></td></tr>
84 <tr class="memitem:ad34fd99c65e2e4beb98670411f40ca7b" id="r_ad34fd99c65e2e4beb98670411f40ca7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad34fd99c65e2e4beb98670411f40ca7b">LatLongDistanceKeyMaker</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;centre_, const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;metric_)</td></tr>
85 <tr class="memdesc:ad34fd99c65e2e4beb98670411f40ca7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. <br /></td></tr>
86 <tr class="memitem:ac66649fcb77438580eb8d59143c6d58d" id="r_ac66649fcb77438580eb8d59143c6d58d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac66649fcb77438580eb8d59143c6d58d">LatLongDistanceKeyMaker</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot_, const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;centre_)</td></tr>
87 <tr class="memdesc:ac66649fcb77438580eb8d59143c6d58d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. <br /></td></tr>
88 <tr class="memitem:a931a11c99b88b0813e7a6c0110c407c7" id="r_a931a11c99b88b0813e7a6c0110c407c7"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a931a11c99b88b0813e7a6c0110c407c7">operator()</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &amp;doc) const</td></tr>
89 <tr class="memdesc:a931a11c99b88b0813e7a6c0110c407c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a key string for a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Document</a>. <br /></td></tr>
90 <tr class="inherit_header pub_methods_classXapian_1_1KeyMaker"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classXapian_1_1KeyMaker')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classXapian_1_1KeyMaker.html">Xapian::KeyMaker</a></td></tr>
91 <tr class="memitem:aa3763f7445b5b20dffa6448ffc9ae0ed inherit pub_methods_classXapian_1_1KeyMaker" id="r_aa3763f7445b5b20dffa6448ffc9ae0ed"><td class="memItemLeft" align="right" valign="top">
92 &#160;</td><td class="memItemRight" valign="bottom"><b>KeyMaker</b> ()</td></tr>
93 <tr class="memdesc:aa3763f7445b5b20dffa6448ffc9ae0ed inherit pub_methods_classXapian_1_1KeyMaker"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
94 <tr class="memitem:a3536ee93f8588a7af834212e9c09c5f8 inherit pub_methods_classXapian_1_1KeyMaker" id="r_a3536ee93f8588a7af834212e9c09c5f8"><td class="memItemLeft" align="right" valign="top">
95 virtual&#160;</td><td class="memItemRight" valign="bottom"><b>~KeyMaker</b> ()</td></tr>
96 <tr class="memdesc:a3536ee93f8588a7af834212e9c09c5f8 inherit pub_methods_classXapian_1_1KeyMaker"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor, because we have virtual methods. <br /></td></tr>
97 <tr class="memitem:ab62225b04de86a94b262cb99d91b25fa inherit pub_methods_classXapian_1_1KeyMaker" id="r_ab62225b04de86a94b262cb99d91b25fa"><td class="memItemLeft" align="right" valign="top">KeyMaker *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1KeyMaker.html#ab62225b04de86a94b262cb99d91b25fa">release</a> ()</td></tr>
98 <tr class="memdesc:ab62225b04de86a94b262cb99d91b25fa inherit pub_methods_classXapian_1_1KeyMaker"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start reference counting this object. <br /></td></tr>
99 <tr class="memitem:a5c930f836b425c9694c77bd6b314f66b inherit pub_methods_classXapian_1_1KeyMaker" id="r_a5c930f836b425c9694c77bd6b314f66b"><td class="memItemLeft" align="right" valign="top">const KeyMaker *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1KeyMaker.html#a5c930f836b425c9694c77bd6b314f66b">release</a> () const</td></tr>
100 <tr class="memdesc:a5c930f836b425c9694c77bd6b314f66b inherit pub_methods_classXapian_1_1KeyMaker"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start reference counting this object. <br /></td></tr>
101 </table>
102 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
103 <div class="textblock"><p><a class="el" href="classXapian_1_1KeyMaker.html" title="Virtual base class for key making functors.">KeyMaker</a> subclass which sorts by distance from a latitude/longitude. </p>
104 <p>Experimental - see <a href="https://xapian.org/docs/deprecation#experimental-features">https://xapian.org/docs/deprecation#experimental-features</a></p>
105 <p>Results are ordered by the distance from a fixed point, or list of points, calculated according to the metric supplied. If multiple points are supplied (either in the constructor, or in the coordinates stored in a document), the closest pointwise distance is used.</p>
106 <p>If a document contains no coordinate stored in the specified slot, a special value for the distance will be used. This defaults to a large number, so that such results get a low rank, but may be specified by a constructor parameter. </p>
107 </div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
108 <a id="a18ec53fcc714fe0de6ca23df4ca18d3e" name="a18ec53fcc714fe0de6ca23df4ca18d3e"></a>
109 <h2 class="memtitle"><span class="permalink"><a href="#a18ec53fcc714fe0de6ca23df4ca18d3e">&#9670;&#160;</a></span>LatLongDistanceKeyMaker() <span class="overload">[1/6]</span></h2>
110
111 <div class="memitem">
112 <div class="memproto">
113 <table class="mlabels">
114 <tr>
115 <td class="mlabels-left">
116 <table class="memname">
117 <tr>
118 <td class="memname">Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker </td>
119 <td>(</td>
120 <td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a></td> <td class="paramname"><span class="paramname"><em>slot_</em></span>, </td>
121 </tr>
122 <tr>
123 <td class="paramkey"></td>
124 <td></td>
125 <td class="paramtype">const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &amp;</td> <td class="paramname"><span class="paramname"><em>centre_</em></span>, </td>
126 </tr>
127 <tr>
128 <td class="paramkey"></td>
129 <td></td>
130 <td class="paramtype">const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;</td> <td class="paramname"><span class="paramname"><em>metric_</em></span>, </td>
131 </tr>
132 <tr>
133 <td class="paramkey"></td>
134 <td></td>
135 <td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>defdistance</em></span>&#160;)</td>
136 </tr>
137 </table>
138 </td>
139 <td class="mlabels-right">
140 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
141 </tr>
142 </table>
143 </div><div class="memdoc">
144
145 <p>Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. </p>
146 <dl class="params"><dt>Parameters</dt><dd>
147 <table class="params">
148 <tr><td class="paramname">slot_</td><td>Value slot to use. </td></tr>
149 <tr><td class="paramname">centre_</td><td>List of points to calculate distance from (closest distance is used). </td></tr>
150 <tr><td class="paramname">metric_</td><td><a class="el" href="classXapian_1_1LatLongMetric.html" title="Base class for calculating distances between two lat/long coordinates.">LatLongMetric</a> to use. </td></tr>
151 <tr><td class="paramname">defdistance</td><td>Distance to use for docs with no value set. </td></tr>
152 </table>
153 </dd>
154 </dl>
155
156 <p class="reference">References <a class="el" href="namespaceXapian.html#a29a741b4cda98e10ed5f2fc784039065">Xapian::sortable_serialise()</a>.</p>
157
158 </div>
159 </div>
160 <a id="aac32f708de1e9743834cec4d93d9b293" name="aac32f708de1e9743834cec4d93d9b293"></a>
161 <h2 class="memtitle"><span class="permalink"><a href="#aac32f708de1e9743834cec4d93d9b293">&#9670;&#160;</a></span>LatLongDistanceKeyMaker() <span class="overload">[2/6]</span></h2>
162
163 <div class="memitem">
164 <div class="memproto">
165 <table class="mlabels">
166 <tr>
167 <td class="mlabels-left">
168 <table class="memname">
169 <tr>
170 <td class="memname">Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker </td>
171 <td>(</td>
172 <td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a></td> <td class="paramname"><span class="paramname"><em>slot_</em></span>, </td>
173 </tr>
174 <tr>
175 <td class="paramkey"></td>
176 <td></td>
177 <td class="paramtype">const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &amp;</td> <td class="paramname"><span class="paramname"><em>centre_</em></span>, </td>
178 </tr>
179 <tr>
180 <td class="paramkey"></td>
181 <td></td>
182 <td class="paramtype">const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;</td> <td class="paramname"><span class="paramname"><em>metric_</em></span>&#160;)</td>
183 </tr>
184 </table>
185 </td>
186 <td class="mlabels-right">
187 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
188 </tr>
189 </table>
190 </div><div class="memdoc">
191
192 <p>Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. </p>
193 <dl class="params"><dt>Parameters</dt><dd>
194 <table class="params">
195 <tr><td class="paramname">slot_</td><td>Value slot to use. </td></tr>
196 <tr><td class="paramname">centre_</td><td>List of points to calculate distance from (closest distance is used). </td></tr>
197 <tr><td class="paramname">metric_</td><td><a class="el" href="classXapian_1_1LatLongMetric.html" title="Base class for calculating distances between two lat/long coordinates.">LatLongMetric</a> to use.</td></tr>
198 </table>
199 </dd>
200 </dl>
201 <p>Documents where no value is set are assumed to be a large distance away. </p>
202
203 </div>
204 </div>
205 <a id="a73769e54aadb7cf340ee74de68666814" name="a73769e54aadb7cf340ee74de68666814"></a>
206 <h2 class="memtitle"><span class="permalink"><a href="#a73769e54aadb7cf340ee74de68666814">&#9670;&#160;</a></span>LatLongDistanceKeyMaker() <span class="overload">[3/6]</span></h2>
207
208 <div class="memitem">
209 <div class="memproto">
210 <table class="mlabels">
211 <tr>
212 <td class="mlabels-left">
213 <table class="memname">
214 <tr>
215 <td class="memname">Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker </td>
216 <td>(</td>
217 <td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a></td> <td class="paramname"><span class="paramname"><em>slot_</em></span>, </td>
218 </tr>
219 <tr>
220 <td class="paramkey"></td>
221 <td></td>
222 <td class="paramtype">const <a class="el" href="classXapian_1_1LatLongCoords.html">LatLongCoords</a> &amp;</td> <td class="paramname"><span class="paramname"><em>centre_</em></span>&#160;)</td>
223 </tr>
224 </table>
225 </td>
226 <td class="mlabels-right">
227 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
228 </tr>
229 </table>
230 </div><div class="memdoc">
231
232 <p>Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. </p>
233 <dl class="params"><dt>Parameters</dt><dd>
234 <table class="params">
235 <tr><td class="paramname">slot_</td><td>Value slot to use. </td></tr>
236 <tr><td class="paramname">centre_</td><td>List of points to calculate distance from (closest distance is used).</td></tr>
237 </table>
238 </dd>
239 </dl>
240 <p><a class="el" href="classXapian_1_1GreatCircleMetric.html" title="Calculate the great-circle distance between two coordinates on a sphere.">Xapian::GreatCircleMetric</a> is used as the metric.</p>
241 <p>Documents where no value is set are assumed to be a large distance away. </p>
242
243 </div>
244 </div>
245 <a id="aaa237f65e70a244c74a56ef73ca778ed" name="aaa237f65e70a244c74a56ef73ca778ed"></a>
246 <h2 class="memtitle"><span class="permalink"><a href="#aaa237f65e70a244c74a56ef73ca778ed">&#9670;&#160;</a></span>LatLongDistanceKeyMaker() <span class="overload">[4/6]</span></h2>
247
248 <div class="memitem">
249 <div class="memproto">
250 <table class="mlabels">
251 <tr>
252 <td class="mlabels-left">
253 <table class="memname">
254 <tr>
255 <td class="memname">Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker </td>
256 <td>(</td>
257 <td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a></td> <td class="paramname"><span class="paramname"><em>slot_</em></span>, </td>
258 </tr>
259 <tr>
260 <td class="paramkey"></td>
261 <td></td>
262 <td class="paramtype">const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;</td> <td class="paramname"><span class="paramname"><em>centre_</em></span>, </td>
263 </tr>
264 <tr>
265 <td class="paramkey"></td>
266 <td></td>
267 <td class="paramtype">const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;</td> <td class="paramname"><span class="paramname"><em>metric_</em></span>, </td>
268 </tr>
269 <tr>
270 <td class="paramkey"></td>
271 <td></td>
272 <td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>defdistance</em></span>&#160;)</td>
273 </tr>
274 </table>
275 </td>
276 <td class="mlabels-right">
277 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
278 </tr>
279 </table>
280 </div><div class="memdoc">
281
282 <p>Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. </p>
283 <dl class="params"><dt>Parameters</dt><dd>
284 <table class="params">
285 <tr><td class="paramname">slot_</td><td>Value slot to use. </td></tr>
286 <tr><td class="paramname">centre_</td><td>Point to calculate distance from. </td></tr>
287 <tr><td class="paramname">metric_</td><td><a class="el" href="classXapian_1_1LatLongMetric.html" title="Base class for calculating distances between two lat/long coordinates.">LatLongMetric</a> to use. </td></tr>
288 <tr><td class="paramname">defdistance</td><td>Distance to use for docs with no value set. </td></tr>
289 </table>
290 </dd>
291 </dl>
292
293 <p class="reference">References <a class="el" href="namespaceXapian.html#a29a741b4cda98e10ed5f2fc784039065">Xapian::sortable_serialise()</a>.</p>
294
295 </div>
296 </div>
297 <a id="ad34fd99c65e2e4beb98670411f40ca7b" name="ad34fd99c65e2e4beb98670411f40ca7b"></a>
298 <h2 class="memtitle"><span class="permalink"><a href="#ad34fd99c65e2e4beb98670411f40ca7b">&#9670;&#160;</a></span>LatLongDistanceKeyMaker() <span class="overload">[5/6]</span></h2>
299
300 <div class="memitem">
301 <div class="memproto">
302 <table class="mlabels">
303 <tr>
304 <td class="mlabels-left">
305 <table class="memname">
306 <tr>
307 <td class="memname">Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker </td>
308 <td>(</td>
309 <td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a></td> <td class="paramname"><span class="paramname"><em>slot_</em></span>, </td>
310 </tr>
311 <tr>
312 <td class="paramkey"></td>
313 <td></td>
314 <td class="paramtype">const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;</td> <td class="paramname"><span class="paramname"><em>centre_</em></span>, </td>
315 </tr>
316 <tr>
317 <td class="paramkey"></td>
318 <td></td>
319 <td class="paramtype">const <a class="el" href="classXapian_1_1LatLongMetric.html">LatLongMetric</a> &amp;</td> <td class="paramname"><span class="paramname"><em>metric_</em></span>&#160;)</td>
320 </tr>
321 </table>
322 </td>
323 <td class="mlabels-right">
324 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
325 </tr>
326 </table>
327 </div><div class="memdoc">
328
329 <p>Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. </p>
330 <dl class="params"><dt>Parameters</dt><dd>
331 <table class="params">
332 <tr><td class="paramname">slot_</td><td>Value slot to use. </td></tr>
333 <tr><td class="paramname">centre_</td><td>Point to calculate distance from. </td></tr>
334 <tr><td class="paramname">metric_</td><td><a class="el" href="classXapian_1_1LatLongMetric.html" title="Base class for calculating distances between two lat/long coordinates.">LatLongMetric</a> to use.</td></tr>
335 </table>
336 </dd>
337 </dl>
338 <p>Documents where no value is set are assumed to be a large distance away. </p>
339
340 </div>
341 </div>
342 <a id="ac66649fcb77438580eb8d59143c6d58d" name="ac66649fcb77438580eb8d59143c6d58d"></a>
343 <h2 class="memtitle"><span class="permalink"><a href="#ac66649fcb77438580eb8d59143c6d58d">&#9670;&#160;</a></span>LatLongDistanceKeyMaker() <span class="overload">[6/6]</span></h2>
344
345 <div class="memitem">
346 <div class="memproto">
347 <table class="mlabels">
348 <tr>
349 <td class="mlabels-left">
350 <table class="memname">
351 <tr>
352 <td class="memname">Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker </td>
353 <td>(</td>
354 <td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a></td> <td class="paramname"><span class="paramname"><em>slot_</em></span>, </td>
355 </tr>
356 <tr>
357 <td class="paramkey"></td>
358 <td></td>
359 <td class="paramtype">const <a class="el" href="structXapian_1_1LatLongCoord.html">LatLongCoord</a> &amp;</td> <td class="paramname"><span class="paramname"><em>centre_</em></span>&#160;)</td>
360 </tr>
361 </table>
362 </td>
363 <td class="mlabels-right">
364 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
365 </tr>
366 </table>
367 </div><div class="memdoc">
368
369 <p>Construct a <a class="el" href="classXapian_1_1LatLongDistanceKeyMaker.html" title="KeyMaker subclass which sorts by distance from a latitude/longitude.">LatLongDistanceKeyMaker</a>. </p>
370 <dl class="params"><dt>Parameters</dt><dd>
371 <table class="params">
372 <tr><td class="paramname">slot_</td><td>Value slot to use. </td></tr>
373 <tr><td class="paramname">centre_</td><td>Point to calculate distance from.</td></tr>
374 </table>
375 </dd>
376 </dl>
377 <p><a class="el" href="classXapian_1_1GreatCircleMetric.html" title="Calculate the great-circle distance between two coordinates on a sphere.">Xapian::GreatCircleMetric</a> is used as the metric.</p>
378 <p>Documents where no value is set are assumed to be a large distance away. </p>
379
380 </div>
381 </div>
382 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
383 <a id="a931a11c99b88b0813e7a6c0110c407c7" name="a931a11c99b88b0813e7a6c0110c407c7"></a>
384 <h2 class="memtitle"><span class="permalink"><a href="#a931a11c99b88b0813e7a6c0110c407c7">&#9670;&#160;</a></span>operator()()</h2>
385
386 <div class="memitem">
387 <div class="memproto">
388 <table class="mlabels">
389 <tr>
390 <td class="mlabels-left">
391 <table class="memname">
392 <tr>
393 <td class="memname">std::string Xapian::LatLongDistanceKeyMaker::operator() </td>
394 <td>(</td>
395 <td class="paramtype">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &amp;</td> <td class="paramname"><span class="paramname"><em>doc</em></span></td><td>)</td>
396 <td> const</td>
397 </tr>
398 </table>
399 </td>
400 <td class="mlabels-right">
401 <span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
402 </tr>
403 </table>
404 </div><div class="memdoc">
405
406 <p>Build a key string for a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Document</a>. </p>
407 <p>These keys can be used for sorting or collapsing matching documents.</p>
408 <dl class="params"><dt>Parameters</dt><dd>
409 <table class="params">
410 <tr><td class="paramname">doc</td><td><a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database.">Document</a> object to build a key for. </td></tr>
411 </table>
412 </dd>
413 </dl>
414
415 <p>Implements <a class="el" href="classXapian_1_1KeyMaker.html#acd0a775f8546a830833357e5d792bedc">Xapian::KeyMaker</a>.</p>
416
417 </div>
418 </div>
419 <hr/>The documentation for this class was generated from the following file:<ul>
420 <li>xapian/<a class="el" href="geospatial_8h.html">geospatial.h</a></li>
421 </ul>
422 </div><!-- contents -->
423 <!-- start footer part -->
424 <hr class="footer"/><address class="footer"><small>
425 Generated by <a href="https://www.doxygen.org/">Doxygen 1.15.0</a>
426 </small></address>
427 </body>
428 </html>