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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>length (with strategy)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Geometry">
<link rel="up" href="../length.html" title="length">
<link rel="prev" href="length_1.html" title="length">
<link rel="next" href="../make.html" title="make">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="length_1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../length.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../make.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry.reference.algorithms.length.length_2_with_strategy"></a><a class="link" href="length_2_with_strategy.html" title="length (with strategy)">length
(with strategy)</a>
</h5></div></div></div>
<p>
<a class="indexterm" name="idp115757408"></a>
Calculates the length of a geometry using the specified strategy.
</p>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h0"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.description"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.description">Description</a>
</h6>
<p>
The free function length calculates the length (the sum of distances
between consecutive points) of a geometry using the specified strategy.
Reasons to specify a strategy include: use another coordinate system
for calculations; construct the strategy beforehand (e.g. with the radius
of the Earth); select a strategy when there are more than one available
for a calculation.
</p>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h1"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.synopsis"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Strategy</span><span class="special">></span>
<span class="identifier">default_length_result</span><span class="special"><</span><span class="identifier">Geometry</span><span class="special">>::</span><span class="identifier">type</span> <span class="identifier">length</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">geometry</span><span class="special">,</span> <span class="identifier">Strategy</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">strategy</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h2"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.parameters"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Concept
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
Geometry const &
</p>
</td>
<td>
<p>
Any type fulfilling a Geometry Concept
</p>
</td>
<td>
<p>
geometry
</p>
</td>
<td>
<p>
A model of the specified concept
</p>
</td>
</tr>
<tr>
<td>
<p>
Strategy const &
</p>
</td>
<td>
<p>
Any type fulfilling a distance Strategy Concept
</p>
</td>
<td>
<p>
strategy
</p>
</td>
<td>
<p>
The strategy which will be used for distance calculations
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h3"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.returns"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.returns">Returns</a>
</h6>
<p>
The calculated length
</p>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h4"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.header"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.header">Header</a>
</h6>
<p>
Either
</p>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<p>
Or
</p>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">algorithms</span><span class="special">/</span><span class="identifier">length</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>
</p>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h5"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.conformance"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.conformance">Conformance</a>
</h6>
<p>
The function length implements function Length from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC
Simple Feature Specification</a>.
</p>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h6"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.behavior"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.behavior">Behavior</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Case
</p>
</th>
<th>
<p>
Behavior
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
pointlike (e.g. point)
</p>
</td>
<td>
<p>
Returns 0
</p>
</td>
</tr>
<tr>
<td>
<p>
linear (e.g. linestring)
</p>
</td>
<td>
<p>
Returns the length
</p>
</td>
</tr>
<tr>
<td>
<p>
areal (e.g. polygon)
</p>
</td>
<td>
<p>
Returns 0
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h7"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.complexity"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.complexity">Complexity</a>
</h6>
<p>
Linear
</p>
<h6>
<a name="geometry.reference.algorithms.length.length_2_with_strategy.h8"></a>
<span class="phrase"><a name="geometry.reference.algorithms.length.length_2_with_strategy.examples"></a></span><a class="link" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.examples">Examples</a>
</h6>
<p>
The following example shows the length measured over a sphere, expressed
in kilometers. To do that the radius of the sphere must be specified
in the constructor of the strategy.
</p>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">linestring</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">model</span><span class="special">::</span><span class="identifier">point</span><span class="special"><</span><span class="keyword">float</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="identifier">cs</span><span class="special">::</span><span class="identifier">spherical_equatorial</span><span class="special"><</span><span class="identifier">degree</span><span class="special">></span> <span class="special">></span> <span class="identifier">P</span><span class="special">;</span>
<span class="identifier">model</span><span class="special">::</span><span class="identifier">linestring</span><span class="special"><</span><span class="identifier">P</span><span class="special">></span> <span class="identifier">line</span><span class="special">;</span>
<span class="identifier">line</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">P</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">41</span><span class="special">));</span>
<span class="identifier">line</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">P</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">48</span><span class="special">));</span>
<span class="identifier">line</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">P</span><span class="special">(</span><span class="number">5</span><span class="special">,</span> <span class="number">52</span><span class="special">));</span>
<span class="keyword">double</span> <span class="keyword">const</span> <span class="identifier">mean_radius</span> <span class="special">=</span> <span class="number">6371.0</span><span class="special">;</span> <a class="co" name="geometry.reference.algorithms.length.length_2_with_strategy.c0" href="length_2_with_strategy.html#geometry.reference.algorithms.length.length_2_with_strategy.c1"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"length is "</span>
<span class="special"><<</span> <span class="identifier">length</span><span class="special">(</span><span class="identifier">line</span><span class="special">,</span> <span class="identifier">strategy</span><span class="special">::</span><span class="identifier">distance</span><span class="special">::</span><span class="identifier">haversine</span><span class="special"><</span><span class="keyword">float</span><span class="special">>(</span><span class="identifier">mean_radius</span><span class="special">)</span> <span class="special">)</span>
<span class="special"><<</span> <span class="string">" kilometers "</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<div class="calloutlist"><table border="0" summary="Callout list"><tr>
<td width="5%" valign="top" align="left"><p><a name="geometry.reference.algorithms.length.length_2_with_strategy.c1"></a><a href="#geometry.reference.algorithms.length.length_2_with_strategy.c0"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td>
<td valign="top" align="left"><p>
<a href="http://en.wikipedia.org/wiki/Earth_radius" target="_top">Wiki</a>
</p></td>
</tr></table></div>
<p>
Output:
</p>
<pre class="programlisting">length is 1272.03 kilometers
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Barend Gehrels, Bruno Lalande,
Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="length_1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../length.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../make.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
