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

247 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/append.hpp</h1><a href="append_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_APPEND_HPP</span>
<a name="l00010"></a>00010 <span class="preprocessor"></span><span class="preprocessor">#define BOOST_GEOMETRY_ALGORITHMS_APPEND_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/type_traits/remove_const.hpp&gt;</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;<a class="code" href="access_8hpp.html">boost/geometry/core/access.hpp</a>&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;<a class="code" href="core_2point__type_8hpp.html">boost/geometry/core/point_type.hpp</a>&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;<a class="code" href="core_2tags_8hpp.html">boost/geometry/core/tags.hpp</a>&gt;</span>
<a name="l00019"></a>00019
<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="l00022"></a>00022 <span class="preprocessor">#include &lt;<a class="code" href="copy_8hpp.html">boost/geometry/util/copy.hpp</a>&gt;</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>geometry
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef DOXYGEN_NO_DETAIL</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="keyword">namespace </span>detail { <span class="keyword">namespace </span><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a> {
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>, <span class="keywordtype">bool</span> UseStd&gt;
<a name="l00032"></a>00032 <span class="keyword">struct </span>append_point {};
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>&gt;
<a name="l00035"></a>00035 <span class="keyword">struct </span>append_point&lt;Geometry, Point, true&gt;
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Geometry&amp; geometry, Point <span class="keyword">const</span>&amp; point, <span class="keywordtype">int</span> , <span class="keywordtype">int</span> )
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">typename</span> point_type&lt;Geometry&gt;::type point_type;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <a class="code" href="namespaceboost_1_1geometry.html#ff15abe2a4412c1913d5c4d5875f45f7" title="Copies coordinates from source to destination point.">copy_coordinates</a>(point, point_type);
<a name="l00042"></a>00042 geometry.push_back(point_type);
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044 };
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>&gt;
<a name="l00047"></a>00047 <span class="keyword">struct </span>append_point&lt;Geometry, Point, false&gt;
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Geometry&amp; geometry, Point <span class="keyword">const</span>&amp; point,
<a name="l00050"></a>00050 <span class="keywordtype">int</span> ring_index, <span class="keywordtype">int</span> multi_index)
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 traits::append_point&lt;Geometry, Point&gt;::apply(geometry, point,
<a name="l00053"></a>00053 ring_index, multi_index);
<a name="l00054"></a>00054 }
<a name="l00055"></a>00055 };
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> Range, <span class="keywordtype">bool</span> UseStd&gt;
<a name="l00058"></a>00058 <span class="keyword">struct </span>append_range
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 <span class="keyword">typedef</span> <span class="keyword">typename</span> boost::range_value&lt;Range&gt;::type point_type;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Geometry&amp; geometry, Range <span class="keyword">const</span>&amp; range,
<a name="l00063"></a>00063 <span class="keywordtype">int</span> ring_index, <span class="keywordtype">int</span> multi_index)
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065 <span class="keywordflow">for</span> (<span class="keyword">typename</span> boost::range_const_iterator&lt;Range&gt;::type
<a name="l00066"></a>00066 it = boost::begin(range);
<a name="l00067"></a>00067 it != boost::end(range);
<a name="l00068"></a>00068 ++it)
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 append_point&lt;Geometry, point_type, UseStd&gt;::apply(geometry, *it,
<a name="l00071"></a>00071 ring_index, multi_index);
<a name="l00072"></a>00072 }
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074 };
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Polygon, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>, <span class="keywordtype">bool</span> Std&gt;
<a name="l00077"></a>00077 <span class="keyword">struct </span>point_to_poly
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <span class="keyword">typedef</span> <span class="keyword">typename</span> ring_type&lt;Polygon&gt;::type range_type;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Polygon&amp; polygon, Point <span class="keyword">const</span>&amp; point,
<a name="l00082"></a>00082 <span class="keywordtype">int</span> ring_index, <span class="keywordtype">int</span> )
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 <span class="keywordflow">if</span> (ring_index == -1)
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 append_point&lt;range_type, Point, Std&gt;::apply(
<a name="l00087"></a>00087 <a class="code" href="group__access.html#gd96ba07cd3c6c3216bd5ab69adc9ccb5" title="Function to get the exterior_ring ring of a polygon.">exterior_ring</a>(polygon), point, -1, -1);
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ring_index &lt; <span class="keywordtype">int</span>(<a class="code" href="group__access.html#gfed6b5ddd56682edff7b3b123bd26992" title="Function to get the number of interior rings of a polygon.">num_interior_rings</a>(polygon)))
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 append_point&lt;range_type, Point, Std&gt;::apply(
<a name="l00092"></a>00092 <a class="code" href="group__access.html#g5af585b056bb80bf3dfe7c07ad30d84a" title="Function to get the interior rings of a polygon (non const version).">interior_rings</a>(polygon)[ring_index], point, -1, -1);
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Polygon, <span class="keyword">typename</span> Range, <span class="keywordtype">bool</span> Std&gt;
<a name="l00098"></a>00098 <span class="keyword">struct </span>range_to_poly
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 <span class="keyword">typedef</span> <span class="keyword">typename</span> ring_type&lt;Polygon&gt;::type ring_type;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> apply(Polygon&amp; polygon, Range <span class="keyword">const</span>&amp; range,
<a name="l00103"></a>00103 <span class="keywordtype">int</span> ring_index, <span class="keywordtype">int</span> )
<a name="l00104"></a>00104 {
<a name="l00105"></a>00105 <span class="keywordflow">if</span> (ring_index == -1)
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 append_range&lt;ring_type, Range, Std&gt;::apply(
<a name="l00108"></a>00108 <a class="code" href="group__access.html#gd96ba07cd3c6c3216bd5ab69adc9ccb5" title="Function to get the exterior_ring ring of a polygon.">exterior_ring</a>(polygon), range, -1, -1);
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ring_index &lt; <span class="keywordtype">int</span>(<a class="code" href="group__access.html#gfed6b5ddd56682edff7b3b123bd26992" title="Function to get the number of interior rings of a polygon.">num_interior_rings</a>(polygon)))
<a name="l00111"></a>00111 {
<a name="l00112"></a>00112 append_range&lt;ring_type, Range, Std&gt;::apply(
<a name="l00113"></a>00113 <a class="code" href="group__access.html#g5af585b056bb80bf3dfe7c07ad30d84a" title="Function to get the interior rings of a polygon (non const version).">interior_rings</a>(polygon)[ring_index], range, -1, -1);
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117
<a name="l00118"></a>00118 }} <span class="comment">// namespace detail::append</span>
<a name="l00119"></a>00119 <span class="preprocessor">#endif // DOXYGEN_NO_DETAIL</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span>
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="preprocessor">#ifndef DOXYGEN_NO_DISPATCH</span>
<a name="l00123"></a>00123 <span class="preprocessor"></span><span class="keyword">namespace </span>dispatch
<a name="l00124"></a>00124 {
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="comment">// (RoP = range or point, Std = use std library)</span>
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="comment">// Default case (where RoP will be range/array/etc)</span>
<a name="l00129"></a>00129 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Tag, <span class="keyword">typename</span> TagRoP, <span class="keyword">typename</span> G, <span class="keyword">typename</span> RoP, <span class="keywordtype">bool</span> Std&gt;
<a name="l00130"></a>00130 <span class="keyword">struct </span><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a> : detail::<a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>::append_range&lt;G, RoP, Std&gt; {};
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">// Append a point to any geometry</span>
<a name="l00133"></a>00133 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Tag, <span class="keyword">typename</span> G, <span class="keyword">typename</span> P, <span class="keywordtype">bool</span> Std&gt;
<a name="l00134"></a>00134 <span class="keyword">struct </span><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>&lt;Tag, point_tag, G, P, Std&gt;
<a name="l00135"></a>00135 : detail::<a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>::append_point&lt;G, P, Std&gt; {};
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="comment">// Never possible to append anything to a point/box/n-sphere</span>
<a name="l00138"></a>00138 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> TagRoP, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>, <span class="keyword">typename</span> RoP, <span class="keywordtype">bool</span> Std&gt;
<a name="l00139"></a>00139 <span class="keyword">struct </span><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>&lt;point_tag, TagRoP, Point, RoP, Std&gt; {};
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> TagRoP, <span class="keyword">typename</span> Box, <span class="keyword">typename</span> RoP, <span class="keywordtype">bool</span> Std&gt;
<a name="l00142"></a>00142 <span class="keyword">struct </span><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>&lt;box_tag, TagRoP, Box, RoP, Std&gt; {};
<a name="l00143"></a>00143
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Polygon, <span class="keyword">typename</span> TagRange, <span class="keyword">typename</span> Range, <span class="keywordtype">bool</span> Std&gt;
<a name="l00146"></a>00146 <span class="keyword">struct </span><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>&lt;polygon_tag, TagRange, Polygon, Range, Std&gt;
<a name="l00147"></a>00147 : detail::<a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>::range_to_poly&lt;Polygon, Range, Std&gt; {};
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Polygon, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>, <span class="keywordtype">bool</span> Std&gt;
<a name="l00150"></a>00150 <span class="keyword">struct </span><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>&lt;polygon_tag, point_tag, Polygon, Point, Std&gt;
<a name="l00151"></a>00151 : detail::<a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>::point_to_poly&lt;Polygon, Point, Std&gt; {};
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="comment">// Multi-linestring and multi-polygon might either implement traits</span>
<a name="l00154"></a>00154 <span class="comment">// or use standard...</span>
<a name="l00155"></a>00155
<a name="l00156"></a>00156 } <span class="comment">// namespace dispatch</span>
<a name="l00157"></a>00157 <span class="preprocessor">#endif // DOXYGEN_NO_DISPATCH</span>
<a name="l00158"></a>00158 <span class="preprocessor"></span>
<a name="l00159"></a>00159
<a name="l00169"></a>00169 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Geometry, <span class="keyword">typename</span> RoP&gt;
<a name="l00170"></a><a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb">00170</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">append</a>(Geometry&amp; geometry, RoP <span class="keyword">const</span>&amp; range_or_point,
<a name="l00171"></a>00171 <span class="keywordtype">int</span> ring_index = -1, <span class="keywordtype">int</span> multi_index = 0)
<a name="l00172"></a>00172 {
<a name="l00173"></a>00173 concept::check&lt;Geometry&gt;();
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keyword">typedef</span> <span class="keyword">typename</span> boost::remove_const&lt;Geometry&gt;::type ncg_type;
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <a class="code" href="group__access.html#gaa82516f99aff50c0f96dcc945cf73cb" title="Appends one or more points to a linestring, ring, polygon, multi.">dispatch::append</a>
<a name="l00178"></a>00178 &lt;
<a name="l00179"></a>00179 <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>,
<a name="l00180"></a>00180 <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;RoP&gt;::type</a>,
<a name="l00181"></a>00181 ncg_type,
<a name="l00182"></a>00182 RoP,
<a name="l00183"></a>00183 <a class="code" href="structboost_1_1geometry_1_1traits_1_1use__std.html" title="Traits class, optional, indicating that the std-library should be used.">traits::use_std&lt;ncg_type&gt;::value</a>
<a name="l00184"></a>00184 &gt;::apply(geometry, range_or_point, ring_index, multi_index);
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186
<a name="l00187"></a>00187 }} <span class="comment">// namespace boost::geometry</span>
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="preprocessor">#endif // BOOST_GEOMETRY_ALGORITHMS_APPEND_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>