• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>perimeter (with strategy)</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../../index.html" title="Chapter 1. Geometry">
8<link rel="up" href="../perimeter.html" title="perimeter">
9<link rel="prev" href="perimeter_1.html" title="perimeter">
10<link rel="next" href="../relate.html" title="relate">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<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="../relate.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<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
28          (with strategy)</a>
29</h5></div></div></div>
30<p>
31            <a class="indexterm" name="idm45635690288960"></a>
32Calculates the perimeter of a geometry using the specified strategy.
33          </p>
34<h6>
35<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h0"></a>
36            <span class="phrase"><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>
37          </h6>
38<p>
39            The function perimeter returns the perimeter of a geometry, using specified
40            strategy
41          </p>
42<h6>
43<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h1"></a>
44            <span class="phrase"><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>
45          </h6>
46<p>
47</p>
48<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>
49<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>
50<p>
51          </p>
52<h6>
53<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h2"></a>
54            <span class="phrase"><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>
55          </h6>
56<div class="informaltable"><table class="table">
57<colgroup>
58<col>
59<col>
60<col>
61<col>
62</colgroup>
63<thead><tr>
64<th>
65                    <p>
66                      Type
67                    </p>
68                  </th>
69<th>
70                    <p>
71                      Concept
72                    </p>
73                  </th>
74<th>
75                    <p>
76                      Name
77                    </p>
78                  </th>
79<th>
80                    <p>
81                      Description
82                    </p>
83                  </th>
84</tr></thead>
85<tbody>
86<tr>
87<td>
88                    <p>
89                      Geometry const &amp;
90                    </p>
91                  </td>
92<td>
93                    <p>
94                      Any type fulfilling a Geometry Concept
95                    </p>
96                  </td>
97<td>
98                    <p>
99                      geometry
100                    </p>
101                  </td>
102<td>
103                    <p>
104                      A model of the specified concept
105                    </p>
106                  </td>
107</tr>
108<tr>
109<td>
110                    <p>
111                      Strategy const &amp;
112                    </p>
113                  </td>
114<td>
115                    <p>
116                      Any type fulfilling a distance Strategy Concept
117                    </p>
118                  </td>
119<td>
120                    <p>
121                      strategy
122                    </p>
123                  </td>
124<td>
125                    <p>
126                      strategy to be used for distance calculations.
127                    </p>
128                  </td>
129</tr>
130</tbody>
131</table></div>
132<h6>
133<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h3"></a>
134            <span class="phrase"><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>
135          </h6>
136<p>
137            The calculated perimeter
138          </p>
139<h6>
140<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h4"></a>
141            <span class="phrase"><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>
142          </h6>
143<p>
144            Either
145          </p>
146<p>
147            <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">hpp</span><span class="special">&gt;</span></code>
148          </p>
149<p>
150            Or
151          </p>
152<p>
153            <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>
154          </p>
155<h6>
156<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h5"></a>
157            <span class="phrase"><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>
158          </h6>
159<p>
160            The function perimeter is not defined by OGC.
161          </p>
162<div class="note"><table border="0" summary="Note">
163<tr>
164<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
165<th align="left">Note</th>
166</tr>
167<tr><td align="left" valign="top"><p>
168              PostGIS contains an algorithm with the same name and the same functionality.
169              See the <a href="http://www.postgis.org/docs/ST_Perimeter.html" target="_top">PostGIS
170              documentation</a>.
171            </p></td></tr>
172</table></div>
173<h6>
174<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h6"></a>
175            <span class="phrase"><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>
176          </h6>
177<div class="informaltable"><table class="table">
178<colgroup>
179<col>
180<col>
181</colgroup>
182<thead><tr>
183<th>
184                    <p>
185                      Case
186                    </p>
187                  </th>
188<th>
189                    <p>
190                      Behavior
191                    </p>
192                  </th>
193</tr></thead>
194<tbody>
195<tr>
196<td>
197                    <p>
198                      pointlike (e.g. point)
199                    </p>
200                  </td>
201<td>
202                    <p>
203                      Returns zero
204                    </p>
205                  </td>
206</tr>
207<tr>
208<td>
209                    <p>
210                      linear (e.g. linestring)
211                    </p>
212                  </td>
213<td>
214                    <p>
215                      Returns zero
216                    </p>
217                  </td>
218</tr>
219<tr>
220<td>
221                    <p>
222                      areal (e.g. polygon)
223                    </p>
224                  </td>
225<td>
226                    <p>
227                      Returns the perimeter
228                    </p>
229                  </td>
230</tr>
231</tbody>
232</table></div>
233<h6>
234<a name="geometry.reference.algorithms.perimeter.perimeter_2_with_strategy.h7"></a>
235            <span class="phrase"><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>
236          </h6>
237<p>
238            Linear
239          </p>
240</div>
241<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
242<td align="left"></td>
243<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
244      Wulkiewicz, Oracle and/or its affiliates<p>
245        Distributed under the Boost Software License, Version 1.0. (See accompanying
246        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>)
247      </p>
248</div></td>
249</tr></table>
250<hr>
251<div class="spirit-nav">
252<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="../relate.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
253</div>
254</body>
255</html>
256