Imported Upstream version 1.63.0
[platform/upstream/boost.git] / libs / geometry / doc / doxy / doxygen_output / html_by_doxygen / group__union.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5 <title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
6 <link href="doxygen.css" rel="stylesheet" type="text/css">
7 <link href="tabs.css" rel="stylesheet" type="text/css">
8 </head>
9 <table cellpadding="2" width="100%">
10 <tbody>
11 <tr>
12 <td valign="top">
13 <img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
14 &nbsp;&nbsp;
15 </td>
16 <td valign="top" align="right">
17 <a href="http://www.boost.org">
18 <img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
19 </a>
20 </td>
21 </tr>
22 </tbody>
23 </table>
24 <!-- Generated by Doxygen 1.8.6 -->
25   <div id="navrow1" class="tabs">
26     <ul class="tablist">
27       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
28       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
29       <li><a href="modules.html"><span>Modules</span></a></li>
30       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
31       <li><a href="annotated.html"><span>Classes</span></a></li>
32       <li><a href="files.html"><span>Files</span></a></li>
33       <li><a href="examples.html"><span>Examples</span></a></li>
34     </ul>
35   </div>
36 </div><!-- top -->
37 <div class="header">
38   <div class="summary">
39 <a href="#func-members">Functions</a>  </div>
40   <div class="headertitle">
41 <div class="title">union: calculate new geometry containing geometries A or B</div>  </div>
42 </div><!--header-->
43 <div class="contents">
44 <table class="memberdecls">
45 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
46 Functions</h2></td></tr>
47 <tr class="memitem:gaa300b8994725c85cc71b304713a75501"><td class="memTemplParams" colspan="2">template&lt;typename Geometry1 , typename Geometry2 , typename Collection &gt; </td></tr>
48 <tr class="memitem:gaa300b8994725c85cc71b304713a75501"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__union.html#gaa300b8994725c85cc71b304713a75501">boost::geometry::union_</a> (Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2, Collection &amp;output_collection)</td></tr>
49 <tr class="memdesc:gaa300b8994725c85cc71b304713a75501"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines two geometries which each other.  <a href="#gaa300b8994725c85cc71b304713a75501">More...</a><br/></td></tr>
50 <tr class="separator:gaa300b8994725c85cc71b304713a75501"><td class="memSeparator" colspan="2">&#160;</td></tr>
51 </table>
52 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
53 <h2 class="groupheader">Function Documentation</h2>
54 <a class="anchor" id="gaa300b8994725c85cc71b304713a75501"></a>
55 <div class="memitem">
56 <div class="memproto">
57 <div class="memtemplate">
58 template&lt;typename Geometry1 , typename Geometry2 , typename Collection &gt; </div>
59       <table class="memname">
60         <tr>
61           <td class="memname">void boost::geometry::union_ </td>
62           <td>(</td>
63           <td class="paramtype">Geometry1 const &amp;&#160;</td>
64           <td class="paramname"><em>geometry1</em>, </td>
65         </tr>
66         <tr>
67           <td class="paramkey"></td>
68           <td></td>
69           <td class="paramtype">Geometry2 const &amp;&#160;</td>
70           <td class="paramname"><em>geometry2</em>, </td>
71         </tr>
72         <tr>
73           <td class="paramkey"></td>
74           <td></td>
75           <td class="paramtype">Collection &amp;&#160;</td>
76           <td class="paramname"><em>output_collection</em>&#160;</td>
77         </tr>
78         <tr>
79           <td></td>
80           <td>)</td>
81           <td></td><td></td>
82         </tr>
83       </table>
84 </div><div class="memdoc">
85
86 <p>Combines two geometries which each other. </p>
87 <p>The free function union calculates the spatial set theoretic union of two geometries. </p>
88 <dl class="tparams"><dt>Template Parameters</dt><dd>
89   <table class="tparams">
90     <tr><td class="paramname">Geometry1</td><td>Any type fulfilling a Geometry Concept </td></tr>
91     <tr><td class="paramname">Geometry2</td><td>Any type fulfilling a Geometry Concept </td></tr>
92     <tr><td class="paramname">Collection</td><td>output collection, either a multi-geometry, or a std::vector&lt;Geometry&gt; / std::deque&lt;Geometry&gt; etc </td></tr>
93   </table>
94   </dd>
95 </dl>
96 <dl class="params"><dt>Parameters</dt><dd>
97   <table class="params">
98     <tr><td class="paramname">geometry1</td><td>A model of the specified concept </td></tr>
99     <tr><td class="paramname">geometry2</td><td>A model of the specified concept </td></tr>
100     <tr><td class="paramname">output_collection</td><td>the output collection </td></tr>
101   </table>
102   </dd>
103 </dl>
104 <dl class="section note"><dt>Note</dt><dd>Called union_ because union is a reserved word.</dd></dl>
105  <dl><dt><b>Examples: </b></dt><dd><a class="el" href="03_polygon_example_8cpp-example.html#a13">03_polygon_example.cpp</a>.</dd>
106 </dl>
107 </div>
108 </div>
109 </div><!-- contents -->
110 <hr size="1">
111 <table width="100%">
112 <tbody>
113 <tr>
114 <td align="left"><small>
115 <p>April 2, 2011</p>
116 </small></td>
117 <td align="right">
118 <small>
119 Copyright &copy; 2007-2011 Barend Gehrels, Amsterdam, the Netherlands<br>
120 Copyright &copy; 2008-2011 Bruno Lalande, Paris, France<br>
121 Copyright &copy; 2009-2010 Mateusz Loskot, London, UK<br>
122 </small>
123 </td>
124 </tr>
125 </tbody>
126 </table>
127 <address style="text-align: right;"><small>
128 Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
129 </small></address>
130 </body>
131 </html>