libs/geometry/doc/doxy/doxygen_output/xml/group__relation.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__relation" kind="group">
   4     <compoundname>relation</compoundname>
   5     <title>relation: calculate spatial relation between two geometries</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__relation_1ga6a43ab4b83f66fb53c0dfe34981a6f4b" 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         </templateparamlist>
  16         <type>de9im::matrix</type>
  17         <definition>de9im::matrix boost::geometry::relation</definition>
  18         <argsstring>(Geometry1 const &amp;geometry1, Geometry2 const &amp;geometry2)</argsstring>
  19         <name>relation</name>
  20         <param>
  21           <type>Geometry1 const &amp;</type>
  22           <declname>geometry1</declname>
  23         </param>
  24         <param>
  25           <type>Geometry2 const &amp;</type>
  26           <declname>geometry2</declname>
  27         </param>
  28         <briefdescription>
  29 <para>Calculates the relation between a pair of geometries as defined in DE-9IM. </para>        </briefdescription>
  30         <detaileddescription>
  31 <para><parameterlist kind="templateparam"><parameteritem>
  32 <parameternamelist>
  33 <parametername>Geometry1</parametername>
  34 </parameternamelist>
  35 <parameterdescription>
  36 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  37 </parameteritem>
  38 <parameteritem>
  39 <parameternamelist>
  40 <parametername>Geometry2</parametername>
  41 </parameternamelist>
  42 <parameterdescription>
  43 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  44 </parameteritem>
  45 </parameterlist>
  46 <parameterlist kind="param"><parameteritem>
  47 <parameternamelist>
  48 <parametername>geometry1</parametername>
  49 </parameternamelist>
  50 <parameterdescription>
  51 <para>A model of the specified concept </para></parameterdescription>
  52 </parameteritem>
  53 <parameteritem>
  54 <parameternamelist>
  55 <parametername>geometry2</parametername>
  56 </parameternamelist>
  57 <parameterdescription>
  58 <para>A model of the specified concept </para></parameterdescription>
  59 </parameteritem>
  60 </parameterlist>
  61 <simplesect kind="return"><para>The DE-9IM matrix expressing the relation between geometries.</para></simplesect>
  62  <qbk>[include reference/algorithms/relation.qbk]</qbk>  </para>        </detaileddescription>
  63         <inbodydescription>
  64         </inbodydescription>
  65         <location file="/home/ubuntu/boost/boost/geometry/algorithms/detail/relation/interface.hpp" line="173" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/detail/relation/interface.hpp" bodystart="173" bodyend="181"/>
  66       </memberdef>
  67       </sectiondef>
  68     <briefdescription>
  69     </briefdescription>
  70     <detaileddescription>
  71     </detaileddescription>
  72   </compounddef>
  73 </doxygen>