Files
geometry/doc/doxygen_output/html/algorithms_2envelope_8hpp_source.html
Barend Gehrels 363580fbf6 Added old doxygen docs
[SVN r59777]
2010-02-20 15:57:12 +00:00

291 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<table cellpadding="2" width="100%">
<tbody>
<tr>
<td valign="top">
<img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
&nbsp;&nbsp;
</td>
<td valign="top" align="right">
<a href="http://www.boost.org">
<img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
</a>
</td>
</tr>
</tbody>
</table>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>boost/geometry/algorithms/envelope.hpp</h1><a href="algorithms_2envelope_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Boost.Geometry (aka GGL, Generic Geometry Library)</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Copyright Barend Gehrels 2007-2009, Geodan, Amsterdam, the Netherlands.</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright Bruno Lalande 2008, 2009</span>
<a name="l00005"></a>00005 <span class="comment">// Use, modification and distribution is subject to the Boost Software License,</span>
<a name="l00006"></a>00006 <span class="comment">// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at</span>
<a name="l00007"></a>00007 <span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="preprocessor">#ifndef BOOST_GEOMETRY_ALGORITHMS_ENVELOPE_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define BOOST_GEOMETRY_ALGORITHMS_ENVELOPE_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;boost/range/functions.hpp&gt;</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &lt;boost/range/metafunctions.hpp&gt;</span>
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;boost/numeric/conversion/cast.hpp&gt;</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;<a class="code" href="combine_8hpp.html">boost/geometry/algorithms/combine.hpp</a>&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;<a class="code" href="convert_8hpp.html">boost/geometry/algorithms/convert.hpp</a>&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;<a class="code" href="cs_8hpp.html">boost/geometry/core/cs.hpp</a>&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;<a class="code" href="exterior__ring_8hpp.html">boost/geometry/core/exterior_ring.hpp</a>&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;<a class="code" href="geometries_2concepts_2check_8hpp.html">boost/geometry/geometries/concepts/check.hpp</a>&gt;</span>
<a name="l00021"></a>00021
<a name="l00059"></a>00059 <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>geometry
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="preprocessor">#ifndef DOXYGEN_NO_DETAIL</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="keyword">namespace </span>detail { <span class="keyword">namespace </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a> {
<a name="l00064"></a>00064
<a name="l00065"></a>00065
<a name="l00067"></a>00067 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> Box&gt;
<a name="l00068"></a>00068 <span class="keyword">struct </span>envelope_combine_one
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Geometry <span class="keyword">const</span>&amp; geometry, Box&amp; mbr)
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072 <a class="code" href="group__access.html#g214bc5c2c841a98c58f4d1baca423f86" title="assign to a box inverse infinite">assign_inverse</a>(mbr);
<a name="l00073"></a>00073 <a class="code" href="group__combine.html#g7757b2934a94453246217e5d95a78a07" title="Combines a box with another geometry (box, point).">geometry::combine</a>(mbr, geometry);
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076
<a name="l00077"></a>00077
<a name="l00079"></a>00079 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Range, <span class="keyword">typename</span> Box&gt;
<a name="l00080"></a>00080 <span class="keyword">inline</span> <span class="keywordtype">void</span> envelope_range_additional(Range <span class="keyword">const</span>&amp; range, Box&amp; mbr)
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="keyword">typedef</span> <span class="keyword">typename</span> boost::range_const_iterator&lt;Range&gt;::type iterator_type;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keywordflow">for</span> (iterator_type it = boost::begin(range);
<a name="l00085"></a>00085 it != boost::end(range);
<a name="l00086"></a>00086 ++it)
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 <a class="code" href="group__combine.html#g7757b2934a94453246217e5d95a78a07" title="Combines a box with another geometry (box, point).">geometry::combine</a>(mbr, *it);
<a name="l00089"></a>00089 }
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091
<a name="l00092"></a>00092
<a name="l00093"></a>00093
<a name="l00095"></a>00095 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Range, <span class="keyword">typename</span> Box&gt;
<a name="l00096"></a>00096 <span class="keyword">struct </span>envelope_range
<a name="l00097"></a>00097 {
<a name="l00099"></a>00099 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Range <span class="keyword">const</span>&amp; range, Box&amp; mbr)
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <a class="code" href="group__access.html#g214bc5c2c841a98c58f4d1baca423f86" title="assign to a box inverse infinite">assign_inverse</a>(mbr);
<a name="l00102"></a>00102 envelope_range_additional(range, mbr);
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104 };
<a name="l00105"></a>00105
<a name="l00106"></a>00106 }} <span class="comment">// namespace detail::envelope</span>
<a name="l00107"></a>00107 <span class="preprocessor">#endif // DOXYGEN_NO_DETAIL</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span>
<a name="l00109"></a>00109 <span class="preprocessor">#ifndef DOXYGEN_NO_DISPATCH</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span><span class="keyword">namespace </span>dispatch
<a name="l00111"></a>00111 {
<a name="l00112"></a>00112
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">// Note, the strategy is for future use (less/greater -&gt; compare spherical</span>
<a name="l00115"></a>00115 <span class="comment">// using other methods), defaults are OK for now.</span>
<a name="l00116"></a>00116 <span class="comment">// However, they are already in the template methods</span>
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">template</span>
<a name="l00119"></a>00119 &lt;
<a name="l00120"></a>00120 <span class="keyword">typename</span> Tag1, <span class="keyword">typename</span> Tag2,
<a name="l00121"></a>00121 <span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> Box,
<a name="l00122"></a>00122 <span class="keyword">typename</span> StrategyLess, <span class="keyword">typename</span> StrategyGreater
<a name="l00123"></a>00123 &gt;
<a name="l00124"></a>00124 <span class="keyword">struct </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a> {};
<a name="l00125"></a>00125
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">template</span>
<a name="l00128"></a>00128 &lt;
<a name="l00129"></a>00129 <span class="keyword">typename</span> Point, <span class="keyword">typename</span> Box,
<a name="l00130"></a>00130 <span class="keyword">typename</span> StrategyLess, <span class="keyword">typename</span> StrategyGreater
<a name="l00131"></a>00131 &gt;
<a name="l00132"></a>00132 <span class="keyword">struct </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>
<a name="l00133"></a>00133 &lt;
<a name="l00134"></a>00134 point_tag, box_tag,
<a name="l00135"></a>00135 Point, Box,
<a name="l00136"></a>00136 StrategyLess, StrategyGreater
<a name="l00137"></a>00137 &gt;
<a name="l00138"></a>00138 : detail::<a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>::envelope_combine_one&lt;Point, Box&gt;
<a name="l00139"></a>00139 {};
<a name="l00140"></a>00140
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">template</span>
<a name="l00143"></a>00143 &lt;
<a name="l00144"></a>00144 <span class="keyword">typename</span> BoxIn, <span class="keyword">typename</span> BoxOut,
<a name="l00145"></a>00145 <span class="keyword">typename</span> StrategyLess, <span class="keyword">typename</span> StrategyGreater
<a name="l00146"></a>00146 &gt;
<a name="l00147"></a>00147 <span class="keyword">struct </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>
<a name="l00148"></a>00148 &lt;
<a name="l00149"></a>00149 box_tag, box_tag,
<a name="l00150"></a>00150 BoxIn, BoxOut,
<a name="l00151"></a>00151 StrategyLess, StrategyGreater
<a name="l00152"></a>00152 &gt;
<a name="l00153"></a>00153 : detail::<a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>::envelope_combine_one&lt;BoxIn, BoxOut&gt;
<a name="l00154"></a>00154 {};
<a name="l00155"></a>00155
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="keyword">template</span>
<a name="l00158"></a>00158 &lt;
<a name="l00159"></a>00159 <span class="keyword">typename</span> Segment, <span class="keyword">typename</span> Box,
<a name="l00160"></a>00160 <span class="keyword">typename</span> StrategyLess, <span class="keyword">typename</span> StrategyGreater
<a name="l00161"></a>00161 &gt;
<a name="l00162"></a>00162 <span class="keyword">struct </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>
<a name="l00163"></a>00163 &lt;
<a name="l00164"></a>00164 segment_tag, box_tag,
<a name="l00165"></a>00165 Segment, Box,
<a name="l00166"></a>00166 StrategyLess, StrategyGreater
<a name="l00167"></a>00167 &gt;
<a name="l00168"></a>00168 : detail::<a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>::envelope_combine_one&lt;Segment, Box&gt;
<a name="l00169"></a>00169 {};
<a name="l00170"></a>00170
<a name="l00171"></a>00171
<a name="l00172"></a>00172 <span class="keyword">template</span>
<a name="l00173"></a>00173 &lt;
<a name="l00174"></a>00174 <span class="keyword">typename</span> Linestring, <span class="keyword">typename</span> Box,
<a name="l00175"></a>00175 <span class="keyword">typename</span> StrategyLess, <span class="keyword">typename</span> StrategyGreater
<a name="l00176"></a>00176 &gt;
<a name="l00177"></a>00177 <span class="keyword">struct </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>
<a name="l00178"></a>00178 &lt;
<a name="l00179"></a>00179 linestring_tag, box_tag,
<a name="l00180"></a>00180 Linestring, Box,
<a name="l00181"></a>00181 StrategyLess, StrategyGreater
<a name="l00182"></a>00182 &gt;
<a name="l00183"></a>00183 : detail::<a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>::envelope_range&lt;Linestring, Box&gt;
<a name="l00184"></a>00184 {};
<a name="l00185"></a>00185
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">template</span>
<a name="l00188"></a>00188 &lt;
<a name="l00189"></a>00189 <span class="keyword">typename</span> Ring, <span class="keyword">typename</span> Box,
<a name="l00190"></a>00190 <span class="keyword">typename</span> StrategyLess, <span class="keyword">typename</span> StrategyGreater
<a name="l00191"></a>00191 &gt;
<a name="l00192"></a>00192 <span class="keyword">struct </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>
<a name="l00193"></a>00193 &lt;
<a name="l00194"></a>00194 ring_tag, box_tag,
<a name="l00195"></a>00195 Ring, Box,
<a name="l00196"></a>00196 StrategyLess, StrategyGreater
<a name="l00197"></a>00197 &gt;
<a name="l00198"></a>00198 : detail::<a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>::envelope_range&lt;Ring, Box&gt;
<a name="l00199"></a>00199 {};
<a name="l00200"></a>00200
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="keyword">template</span>
<a name="l00203"></a>00203 &lt;
<a name="l00204"></a>00204 <span class="keyword">typename</span> Polygon, <span class="keyword">typename</span> Box,
<a name="l00205"></a>00205 <span class="keyword">typename</span> StrategyLess, <span class="keyword">typename</span> StrategyGreater
<a name="l00206"></a>00206 &gt;
<a name="l00207"></a>00207 <span class="keyword">struct </span><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>
<a name="l00208"></a>00208 &lt;
<a name="l00209"></a>00209 polygon_tag, box_tag,
<a name="l00210"></a>00210 Polygon, Box,
<a name="l00211"></a>00211 StrategyLess, StrategyGreater
<a name="l00212"></a>00212 &gt;
<a name="l00213"></a>00213 {
<a name="l00214"></a>00214 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Polygon <span class="keyword">const</span>&amp; poly, Box&amp; mbr)
<a name="l00215"></a>00215 {
<a name="l00216"></a>00216 <span class="comment">// For polygon, inspecting outer ring is sufficient</span>
<a name="l00217"></a>00217
<a name="l00218"></a>00218 detail::envelope::envelope_range
<a name="l00219"></a>00219 &lt;
<a name="l00220"></a>00220 <span class="keyword">typename</span> ring_type&lt;Polygon&gt;::type,
<a name="l00221"></a>00221 Box
<a name="l00222"></a>00222 &gt;::apply(<a class="code" href="group__access.html#gd96ba07cd3c6c3216bd5ab69adc9ccb5" title="Function to get the exterior_ring ring of a polygon.">exterior_ring</a>(poly), mbr);
<a name="l00223"></a>00223 }
<a name="l00224"></a>00224
<a name="l00225"></a>00225 };
<a name="l00226"></a>00226
<a name="l00227"></a>00227
<a name="l00228"></a>00228 } <span class="comment">// namespace dispatch</span>
<a name="l00229"></a>00229 <span class="preprocessor">#endif</span>
<a name="l00230"></a>00230 <span class="preprocessor"></span>
<a name="l00231"></a>00231
<a name="l00244"></a>00244 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> Box&gt;
<a name="l00245"></a><a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a">00245</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">envelope</a>(Geometry <span class="keyword">const</span>&amp; geometry, Box&amp; mbr)
<a name="l00246"></a>00246 {
<a name="l00247"></a>00247 concept::check&lt;const Geometry&gt;();
<a name="l00248"></a>00248 concept::check&lt;Box&gt;();
<a name="l00249"></a>00249
<a name="l00250"></a>00250 <a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">dispatch::envelope</a>
<a name="l00251"></a>00251 &lt;
<a name="l00252"></a>00252 <span class="keyword">typename</span> <a class="code" href="structboost_1_1geometry_1_1geometry__not__recognized__tag.html" title="&amp;quot;default&amp;quot; tag">tag&lt;Geometry&gt;::type</a>, <span class="keyword">typename</span> <a class="code" href="structboost_1_1geometry_1_1geometry__not__recognized__tag.html" title="&amp;quot;default&amp;quot; tag">tag&lt;Box&gt;::type</a>,
<a name="l00253"></a>00253 Geometry, Box,
<a name="l00254"></a>00254 void, <span class="keywordtype">void</span>
<a name="l00255"></a>00255 &gt;::apply(geometry, mbr);
<a name="l00256"></a>00256 }
<a name="l00257"></a>00257
<a name="l00258"></a>00258
<a name="l00264"></a>00264 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Box, <span class="keyword">typename</span> Geometry&gt;
<a name="l00265"></a><a class="code" href="group__envelope.html#g5a758fe381b7ad890a6de13e6e7b08d1">00265</a> <span class="keyword">inline</span> Box <a class="code" href="group__envelope.html#g5a758fe381b7ad890a6de13e6e7b08d1" title="Calculate and return envelope of a geometry.">make_envelope</a>(Geometry <span class="keyword">const</span>&amp; geometry)
<a name="l00266"></a>00266 {
<a name="l00267"></a>00267 concept::check&lt;const Geometry&gt;();
<a name="l00268"></a>00268 concept::check&lt;Box&gt;();
<a name="l00269"></a>00269
<a name="l00270"></a>00270 Box mbr;
<a name="l00271"></a>00271 <a class="code" href="group__envelope.html#g47902cb32df49619702452dbdb45c49a" title="Calculate envelope of a geometry.">dispatch::envelope</a>
<a name="l00272"></a>00272 &lt;
<a name="l00273"></a>00273 <span class="keyword">typename</span> <a class="code" href="structboost_1_1geometry_1_1geometry__not__recognized__tag.html" title="&amp;quot;default&amp;quot; tag">tag&lt;Geometry&gt;::type</a>, <span class="keyword">typename</span> <a class="code" href="structboost_1_1geometry_1_1geometry__not__recognized__tag.html" title="&amp;quot;default&amp;quot; tag">tag&lt;Box&gt;::type</a>,
<a name="l00274"></a>00274 Geometry, Box,
<a name="l00275"></a>00275 void, <span class="keywordtype">void</span>
<a name="l00276"></a>00276 &gt;::apply(geometry, mbr);
<a name="l00277"></a>00277 <span class="keywordflow">return</span> mbr;
<a name="l00278"></a>00278 }
<a name="l00279"></a>00279
<a name="l00280"></a>00280 }} <span class="comment">// namespace boost::geometry</span>
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="preprocessor">#endif // BOOST_GEOMETRY_ALGORITHMS_ENVELOPE_HPP</span>
</pre></div></div>
<hr size="1">
<table width="100%">
<tbody>
<tr>
<td align="left"><small>
<p>December 1, 2009</p>
</small></td>
<td align="right">
<small>Copyright <20> 1995-2009 Barend Gehrels, Geodan, Amsterdam<br>
Copyright <20> 2008-2009 Bruno Lalande, Paris<br>
Copyright <20> 2009 Mateusz Loskot, Cadcorp, London<br>
</small>
</td>
</tr>
</tbody>
</table>
<address style="text-align: right;"><small>
Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
</small></address>
</body>
</html>