summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/html/geometry/reference/algorithms/perimeter/perimeter_2_with_strategy.html
blob: 35682d960799fda20b503bba48e2901f368f1de0 (plain)
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>perimeter (with strategy)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
<link rel="up" href="../perimeter.html" title="perimeter">
<link rel="prev" href="perimeter_1.html" title="perimeter">
<link rel="next" href="../reverse.html" title="reverse">
</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="perimeter_1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../perimeter.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="../reverse.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.perimeter.perimeter_2_with_strategy"></a><a class="link" href="perimeter_2_with_strategy.html" title="perimeter (with strategy)">perimeter
          (with strategy)</a>
</h5></div></div></div>
<p>
            <a class="indexterm" name="id898199"></a>
Calculates the perimeter of a geometry using the specified strategy.
          </p>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h0"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.description"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.description">Description</a>
          </h6>
<p>
            The function perimeter returns the perimeter of a geometry, using specified
            strategy
          </p>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h1"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.synopsis"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.synopsis">Synopsis</a>
          </h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
<span class="identifier">default_length_result</span><span class="special">&lt;</span><span class="identifier">Geometry</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">perimeter</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">,</span> <span class="identifier">Strategy</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">strategy</span><span class="special">)</span></pre>
<p>
          </p>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h2"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.parameters"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_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 &amp;
                    </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 &amp;
                    </p>
                  </td>
<td>
                    <p>
                      Any type fulfilling a distance Strategy Concept
                    </p>
                  </td>
<td>
                    <p>
                      strategy
                    </p>
                  </td>
<td>
                    <p>
                      strategy to be used for distance calculations.
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h3"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.returns"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.returns">Returns</a>
          </h6>
<p>
            The calculated perimeter
          </p>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h4"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.header"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.header">Header</a>
          </h6>
<p>
            Either
          </p>
<p>
            <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
          </p>
<p>
            Or
          </p>
<p>
            <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">perimeter</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
          </p>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h5"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.conformance"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.conformance">Conformance</a>
          </h6>
<p>
            The function perimeter is not defined by OGC.
          </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
              PostGIS contains an algorithm with the same name and the same functionality.
              See the <a href="http://www.postgis.org/docs/ST_Perimeter.html" target="_top">PostGIS
              documentation</a>.
            </p></td></tr>
</table></div>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h6"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.behavior"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_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 zero
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      linear (e.g. linestring)
                    </p>
                  </td>
<td>
                    <p>
                      Returns zero
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      areal (e.g. polygon)
                    </p>
                  </td>
<td>
                    <p>
                      Returns the perimeter
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h7"></a>
            <span><a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.complexity"></a></span><a class="link" href="perimeter_2_with_strategy.html#geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.complexity">Complexity</a>
          </h6>
<p>
            Linear
          </p>
</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 &#169; 2009-2012 Barend
      Gehrels, Bruno Lalande, Mateusz Loskot<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="perimeter_1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../perimeter.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="../reverse.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>