• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>expand</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="../expand.html" title="expand">
9<link rel="prev" href="expand_3_with_strategy.html" title="expand (with strategy)">
10<link rel="next" href="../for_each.html" title="for_each">
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="expand_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expand.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="../for_each.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.expand.expand_2"></a><a class="link" href="expand_2.html" title="expand">expand</a>
28</h5></div></div></div>
29<p>
30            <a class="indexterm" name="idm45635696636800"></a>
31Expands a box using the bounding box (envelope) of another geometry (box,
32            point)
33          </p>
34<h6>
35<a name="geometry.reference.algorithms.expand.expand_2.h0"></a>
36            <span class="phrase"><a name="geometry.reference.algorithms.expand.expand_2.synopsis"></a></span><a class="link" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.synopsis">Synopsis</a>
37          </h6>
38<p>
39</p>
40<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Box</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
41<span class="keyword">void</span> <span class="identifier">expand</span><span class="special">(</span><span class="identifier">Box</span> <span class="special">&amp;</span> <span class="identifier">box</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></pre>
42<p>
43          </p>
44<h6>
45<a name="geometry.reference.algorithms.expand.expand_2.h1"></a>
46            <span class="phrase"><a name="geometry.reference.algorithms.expand.expand_2.parameters"></a></span><a class="link" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.parameters">Parameters</a>
47          </h6>
48<div class="informaltable"><table class="table">
49<colgroup>
50<col>
51<col>
52<col>
53<col>
54</colgroup>
55<thead><tr>
56<th>
57                    <p>
58                      Type
59                    </p>
60                  </th>
61<th>
62                    <p>
63                      Concept
64                    </p>
65                  </th>
66<th>
67                    <p>
68                      Name
69                    </p>
70                  </th>
71<th>
72                    <p>
73                      Description
74                    </p>
75                  </th>
76</tr></thead>
77<tbody>
78<tr>
79<td>
80                    <p>
81                      Box &amp;
82                    </p>
83                  </td>
84<td>
85                    <p>
86                      type of the box
87                    </p>
88                  </td>
89<td>
90                    <p>
91                      box
92                    </p>
93                  </td>
94<td>
95                    <p>
96                      box to be expanded using another geometry, mutable
97                    </p>
98                  </td>
99</tr>
100<tr>
101<td>
102                    <p>
103                      Geometry const &amp;
104                    </p>
105                  </td>
106<td>
107                    <p>
108                      Any type fulfilling a Geometry Concept
109                    </p>
110                  </td>
111<td>
112                    <p>
113                      geometry
114                    </p>
115                  </td>
116<td>
117                    <p>
118                      A model of the specified concept geometry which envelope (bounding
119                      box) will be added to the box
120                    </p>
121                  </td>
122</tr>
123</tbody>
124</table></div>
125<h6>
126<a name="geometry.reference.algorithms.expand.expand_2.h2"></a>
127            <span class="phrase"><a name="geometry.reference.algorithms.expand.expand_2.header"></a></span><a class="link" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.header">Header</a>
128          </h6>
129<p>
130            Either
131          </p>
132<p>
133            <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>
134          </p>
135<p>
136            Or
137          </p>
138<p>
139            <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">expand</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
140          </p>
141<h6>
142<a name="geometry.reference.algorithms.expand.expand_2.h3"></a>
143            <span class="phrase"><a name="geometry.reference.algorithms.expand.expand_2.conformance"></a></span><a class="link" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.conformance">Conformance</a>
144          </h6>
145<p>
146            The function expand is not defined by OGC.
147          </p>
148<h6>
149<a name="geometry.reference.algorithms.expand.expand_2.h4"></a>
150            <span class="phrase"><a name="geometry.reference.algorithms.expand.expand_2.behavior"></a></span><a class="link" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.behavior">Behavior</a>
151          </h6>
152<div class="informaltable"><table class="table">
153<colgroup>
154<col>
155<col>
156</colgroup>
157<thead><tr>
158<th>
159                    <p>
160                      Case
161                    </p>
162                  </th>
163<th>
164                    <p>
165                      Behavior
166                    </p>
167                  </th>
168</tr></thead>
169<tbody>
170<tr>
171<td>
172                    <p>
173                      Box / Point
174                    </p>
175                  </td>
176<td>
177                    <p>
178                      Box is expanded to include the specified Point
179                    </p>
180                  </td>
181</tr>
182<tr>
183<td>
184                    <p>
185                      Box / Box
186                    </p>
187                  </td>
188<td>
189                    <p>
190                      Box is expanded to include the specified Box
191                    </p>
192                  </td>
193</tr>
194<tr>
195<td>
196                    <p>
197                      Box / Other geometries
198                    </p>
199                  </td>
200<td>
201                    <p>
202                      Not yet supported in this version
203                    </p>
204                  </td>
205</tr>
206</tbody>
207</table></div>
208<div class="note"><table border="0" summary="Note">
209<tr>
210<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
211<th align="left">Note</th>
212</tr>
213<tr><td align="left" valign="top"><p>
214              To use expand with another geometry type then specified, use expand(make_envelope&lt;box_type&gt;(geometry)
215            </p></td></tr>
216</table></div>
217<h6>
218<a name="geometry.reference.algorithms.expand.expand_2.h5"></a>
219            <span class="phrase"><a name="geometry.reference.algorithms.expand.expand_2.complexity"></a></span><a class="link" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.complexity">Complexity</a>
220          </h6>
221<p>
222            Linear
223          </p>
224<h6>
225<a name="geometry.reference.algorithms.expand.expand_2.h6"></a>
226            <span class="phrase"><a name="geometry.reference.algorithms.expand.expand_2.example"></a></span><a class="link" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.example">Example</a>
227          </h6>
228<p>
229            Shows the usage of expand
230          </p>
231<p>
232</p>
233<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
234<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">list</span><span class="special">&gt;</span>
235
236<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>
237<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">geometries</span><span class="special">/</span><span class="identifier">box</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
238<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">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
239
240<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
241<span class="special">{</span>
242    <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special">&lt;</span><span class="keyword">short</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">point_type</span><span class="special">;</span>
243    <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">box</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;</span> <span class="identifier">box_type</span><span class="special">;</span>
244
245    <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">expand</span><span class="special">;</span>
246
247    <span class="identifier">box_type</span> <span class="identifier">box</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">make_inverse</span><span class="special">&lt;</span><span class="identifier">box_type</span><span class="special">&gt;();</span> <a class="co" name="geometry.reference.algorithms.expand.expand_2.c0" href="expand_2.html#geometry.reference.algorithms.expand.expand_2.c1"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a>
248
249    <span class="identifier">expand</span><span class="special">(</span><span class="identifier">box</span><span class="special">,</span> <span class="identifier">point_type</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span>
250    <span class="identifier">expand</span><span class="special">(</span><span class="identifier">box</span><span class="special">,</span> <span class="identifier">point_type</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">));</span>
251    <span class="identifier">expand</span><span class="special">(</span><span class="identifier">box</span><span class="special">,</span> <span class="identifier">point_type</span><span class="special">(</span><span class="number">5</span><span class="special">,</span> <span class="number">4</span><span class="special">));</span>
252    <span class="identifier">expand</span><span class="special">(</span><span class="identifier">box</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">make</span><span class="special">&lt;</span><span class="identifier">box_type</span><span class="special">&gt;(</span><span class="number">3</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="number">5</span><span class="special">,</span> <span class="number">5</span><span class="special">));</span>
253
254    <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">dsv</span><span class="special">(</span><span class="identifier">box</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
255
256    <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
257<span class="special">}</span>
258</pre>
259<p>
260          </p>
261<div class="calloutlist"><table border="0" summary="Callout list"><tr>
262<td width="5%" valign="top" align="left"><p><a name="geometry.reference.algorithms.expand.expand_2.c1"></a><a href="#geometry.reference.algorithms.expand.expand_2.c0"><img src="../../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td>
263<td valign="top" align="left"><p>
264                expand is usually preceded by a call to assign_inverse or make_inverse
265              </p></td>
266</tr></table></div>
267<p>
268            Output:
269          </p>
270<pre class="programlisting">((0, 0), (5, 5))
271</pre>
272</div>
273<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
274<td align="left"></td>
275<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
276      Wulkiewicz, Oracle and/or its affiliates<p>
277        Distributed under the Boost Software License, Version 1.0. (See accompanying
278        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>)
279      </p>
280</div></td>
281</tr></table>
282<hr>
283<div class="spirit-nav">
284<a accesskey="p" href="expand_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expand.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="../for_each.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
285</div>
286</body>
287</html>
288