libs/geometry/doc/doxy/doxygen_output/xml/group__difference.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="group__difference" kind="group">
   4     <compoundname>difference</compoundname>
   5     <title>difference: difference of two geometries</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__difference_1gae23e000e550abb271baac3679fae7640" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   8         <templateparamlist>
   9           <param>
  10             <type>typename Geometry1</type>
  11           </param>
  12           <param>
  13             <type>typename Geometry2</type>
  14           </param>
  15           <param>
  16             <type>typename Collection</type>
  17           </param>
  18         </templateparamlist>
  19         <type>void</type>
  20         <definition>void boost::geometry::difference</definition>
  21         <argsstring>(Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2, Collection &amp;output_collection)</argsstring>
  22         <name>difference</name>
  23         <param>
  24           <type>Geometry1 const &amp;</type>
  25           <declname>geometry1</declname>
  26         </param>
  27         <param>
  28           <type>Geometry2 const &amp;</type>
  29           <declname>geometry2</declname>
  30         </param>
  31         <param>
  32           <type>Collection &amp;</type>
  33           <declname>output_collection</declname>
  34         </param>
  35         <briefdescription>
  36         </briefdescription>
  37         <detaileddescription>
  38 <para>Calculate the difference of two geometries</para><para>The free function difference calculates the spatial set theoretic difference of two geometries. <parameterlist kind="templateparam"><parameteritem>
  39 <parameternamelist>
  40 <parametername>Geometry1</parametername>
  41 </parameternamelist>
  42 <parameterdescription>
  43 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  44 </parameteritem>
  45 <parameteritem>
  46 <parameternamelist>
  47 <parametername>Geometry2</parametername>
  48 </parameternamelist>
  49 <parameterdescription>
  50 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  51 </parameteritem>
  52 <parameteritem>
  53 <parameternamelist>
  54 <parametername>Collection</parametername>
  55 </parameternamelist>
  56 <parameterdescription>
  57 <para>output collection, either a multi-geometry, or a std::vector&lt;Geometry&gt; / std::deque&lt;Geometry&gt; etc </para></parameterdescription>
  58 </parameteritem>
  59 </parameterlist>
  60 <parameterlist kind="param"><parameteritem>
  61 <parameternamelist>
  62 <parametername>geometry1</parametername>
  63 </parameternamelist>
  64 <parameterdescription>
  65 <para>A model of the specified concept </para></parameterdescription>
  66 </parameteritem>
  67 <parameteritem>
  68 <parameternamelist>
  69 <parametername>geometry2</parametername>
  70 </parameternamelist>
  71 <parameterdescription>
  72 <para>A model of the specified concept </para></parameterdescription>
  73 </parameteritem>
  74 <parameteritem>
  75 <parameternamelist>
  76 <parametername>output_collection</parametername>
  77 </parameternamelist>
  78 <parameterdescription>
  79 <para>the output collection</para></parameterdescription>
  80 </parameteritem>
  81 </parameterlist>
  82  <qbk>[include reference/algorithms/difference.qbk]</qbk>  </para>        </detaileddescription>
  83         <inbodydescription>
  84         </inbodydescription>
  85         <location file="/home/ubuntu/boost/boost/geometry/algorithms/difference.hpp" line="142" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/difference.hpp" bodystart="142" bodyend="163"/>
  86       </memberdef>
  87       </sectiondef>
  88     <briefdescription>
  89     </briefdescription>
  90     <detaileddescription>
  91     </detaileddescription>
  92   </compounddef>
  93 </doxygen>