Google Git
Sign in
android / platform / external / boost / 077d563efdb280a3d144892e2d0ca01e6a49f454 / . / libs / geometry / doc / html / geometry / reference / algorithms / append.html
blob: 9d56a0b0224b46ff1b9782a04d6780fb2fb2bb1f [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>append</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 1.0">
<link rel="up" href="../algorithms.html" title="Algorithms">
<link rel="prev" href="assign/assign_zero.html" title="assign_zero">
<link rel="next" href="buffer.html" title="buffer">
</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="assign/assign_zero.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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="buffer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry.reference.algorithms.append"></a><a class="link" href="append.html" title="append">append</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="id833568"></a>
Appends one or more points to a linestring, ring, polygon, multi-geometry.
</p>
<a name="geometry.reference.algorithms.append.synopsis"></a><h6>
<a name="geometry.reference.algorithms.append.synopsis-heading"></a>
<a class="link" href="append.html#geometry.reference.algorithms.append.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">RangeOrPoint</span><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">append</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">,</span> <span class="identifier">RangeOrPoint</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">range_or_point</span><span class="special">,</span> <span class="keyword">int</span> <span class="identifier">ring_index</span> <span class="special">=</span> <span class="special">-</span><span class="number">1</span><span class="special">,</span> <span class="keyword">int</span> <span class="identifier">multi_index</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span></pre>
<p>
</p>
<a name="geometry.reference.algorithms.append.parameters"></a><h6>
<a name="geometry.reference.algorithms.append.parameters-heading"></a>
<a class="link" href="append.html#geometry.reference.algorithms.append.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 &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>
RangeOrPoint const &amp;
</p>
</td>
<td>
<p>
Either a range or a point, fullfilling Boost.Range concept or
Boost.Geometry Point Concept
</p>
</td>
<td>
<p>
range_or_point
</p>
</td>
<td>
<p>
The point or range to add
</p>
</td>
</tr>
<tr>
<td>
<p>
int
</p>
</td>
<td>
</td>
<td>
<p>
ring_index
</p>
</td>
<td>
<p>
The index of the ring in case of a polygon: exterior ring (-1,
the default) or interior ring index
</p>
</td>
</tr>
<tr>
<td>
<p>
int
</p>
</td>
<td>
</td>
<td>
<p>
multi_index
</p>
</td>
<td>
<p>
Reserved for multi polygons or multi linestrings
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="geometry.reference.algorithms.append.header"></a><h6>
<a name="geometry.reference.algorithms.append.header-heading"></a>
<a class="link" href="append.html#geometry.reference.algorithms.append.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">append</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<a name="geometry.reference.algorithms.append.behavior"></a><h6>
<a name="geometry.reference.algorithms.append.behavior-heading"></a>
<a class="link" href="append.html#geometry.reference.algorithms.append.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>
Point, Rectangle, Segment
</p>
</td>
<td>
<p>
Compiles, but no action
</p>
</td>
</tr>
<tr>
<td>
<p>
Linestring
</p>
</td>
<td>
<p>
Appends point or range to the end of the linestring
</p>
</td>
</tr>
<tr>
<td>
<p>
Ring
</p>
</td>
<td>
<p>
Appends point or range to the end of the ring (without explicitly
closing it)
</p>
</td>
</tr>
<tr>
<td>
<p>
Polygon
</p>
</td>
<td>
<p>
Appends point or range to the end of the polygon (without explicitly
closing it), either the exterior ring (the default) or specify
a zero-based index for one of the interior rings. In the last
case, the interior rings are not resized automatically, so ensure
that the zero-based index is smaller than the number of interior
rings
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="geometry.reference.algorithms.append.complexity"></a><h6>
<a name="geometry.reference.algorithms.append.complexity-heading"></a>
<a class="link" href="append.html#geometry.reference.algorithms.append.complexity">Complexity</a>
</h6>
<p>
Linear
</p>
<a name="geometry.reference.algorithms.append.example"></a><h6>
<a name="geometry.reference.algorithms.append.example-heading"></a>
<a class="link" href="append.html#geometry.reference.algorithms.append.example">Example</a>
</h6>
<p>
Shows usage of Boost.Geometry's append to append a point or a range to
a polygon
</p>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assign</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<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>
<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">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<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">adapted</span><span class="special">/</span><span class="identifier">boost_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="identifier">BOOST_GEOMETRY_REGISTER_BOOST_TUPLE_CS</span><span class="special">(</span><span class="identifier">cs</span><span class="special">::</span><span class="identifier">cartesian</span><span class="special">)</span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">assign</span><span class="special">::</span><span class="identifier">tuple_list_of</span><span class="special">;</span>
<span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">make_tuple</span><span class="special">;</span>
<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">append</span><span class="special">;</span>
<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">polygon</span><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">tuple</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="special">&gt;</span> <span class="identifier">polygon</span><span class="special">;</span>
<span class="identifier">polygon</span> <span class="identifier">poly</span><span class="special">;</span>
<span class="comment">// Append a range</span>
<span class="identifier">append</span><span class="special">(</span><span class="identifier">poly</span><span class="special">,</span> <span class="identifier">tuple_list_of</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">)(</span><span class="number">0</span><span class="special">,</span> <span class="number">10</span><span class="special">)(</span><span class="number">11</span><span class="special">,</span> <span class="number">11</span><span class="special">)(</span><span class="number">10</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span> <a class="co" name="geometry10co" href="append.html#geometry10"><img src="../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a>
<span class="comment">// Append a point (in this case the closing point</span>
<span class="identifier">append</span><span class="special">(</span><span class="identifier">poly</span><span class="special">,</span> <span class="identifier">make_tuple</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="number">0</span><span class="special">));</span>
<span class="comment">// Create an interior ring (append does not do this automatically)</span>
<span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">interior_rings</span><span class="special">(</span><span class="identifier">poly</span><span class="special">).</span><span class="identifier">resize</span><span class="special">(</span><span class="number">1</span><span class="special">);</span>
<span class="comment">// Append a range to the interior ring</span>
<span class="identifier">append</span><span class="special">(</span><span class="identifier">poly</span><span class="special">,</span> <span class="identifier">tuple_list_of</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">2</span><span class="special">)(</span><span class="number">2</span><span class="special">,</span> <span class="number">5</span><span class="special">)(</span><span class="number">6</span><span class="special">,</span> <span class="number">6</span><span class="special">)(</span><span class="number">5</span><span class="special">,</span> <span class="number">2</span><span class="special">),</span> <span class="number">0</span><span class="special">);</span>
<span class="comment">// Append a point to the first interior ring</span>
<span class="identifier">append</span><span class="special">(</span><span class="identifier">poly</span><span class="special">,</span> <span class="identifier">make_tuple</span><span class="special">(</span><span class="number">2</span><span class="special">,</span> <span class="number">2</span><span class="special">),</span> <span class="number">0</span><span class="special">);</span>
<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">poly</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>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<div class="calloutlist"><table border="0" summary="Callout list"><tr>
<td width="5%" valign="top" align="left"><p><a name="geometry10"></a><a href="#geometry10co"><img src="../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td>
<td valign="top" align="left"><p>
tuple_list_of delivers a range and can therefore be used in boost::geometry::append
</p></td>
</tr></table></div>
<p>
Output:
</p>
<pre class="programlisting">(((0, 0), (0, 10), (11, 11), (10, 0), (0, 0)), ((2, 2), (2, 5), (6, 6), (5, 2), (2, 2)))
</pre>
<a name="geometry.reference.algorithms.append.see_also"></a><h6>
<a name="geometry.reference.algorithms.append.see_also-heading"></a>
<a class="link" href="append.html#geometry.reference.algorithms.append.see_also">See also</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<a class="link" href="assign/assign_points.html" title="assign_points">assign</a>
</li></ul></div>
</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; 2011 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="assign/assign_zero.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../algorithms.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="buffer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>