libs/geometry/doc/doxy/doxygen_output/xml/group__num__interior__rings.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__num__interior__rings" kind="group">
   4     <compoundname>num_interior_rings</compoundname>
   5     <title>number of interior rings: calculate the number of interior rings</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__num__interior__rings_1gad46daea8aff732fece897726c8a1eaf0" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   8         <templateparamlist>
   9           <param>
  10             <type>typename Geometry</type>
  11           </param>
  12         </templateparamlist>
  13         <type>std::size_t</type>
  14         <definition>std::size_t boost::geometry::num_interior_rings</definition>
  15         <argsstring>(Geometry const &amp;geometry)</argsstring>
  16         <name>num_interior_rings</name>
  17         <param>
  18           <type>Geometry const &amp;</type>
  19           <declname>geometry</declname>
  20         </param>
  21         <briefdescription>
  22 <para>Calculates the number of interior rings of a geometry. </para>        </briefdescription>
  23         <detaileddescription>
  24 <para>The free function num_interior_rings calculates the number of interior rings of a geometry. <parameterlist kind="templateparam"><parameteritem>
  25 <parameternamelist>
  26 <parametername>Geometry</parametername>
  27 </parameternamelist>
  28 <parameterdescription>
  29 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  30 </parameteritem>
  31 </parameterlist>
  32 <parameterlist kind="param"><parameteritem>
  33 <parameternamelist>
  34 <parametername>geometry</parametername>
  35 </parameternamelist>
  36 <parameterdescription>
  37 <para>A model of the specified concept </para></parameterdescription>
  38 </parameteritem>
  39 </parameterlist>
  40 <simplesect kind="return"><para>The calculated number of interior rings</para></simplesect>
  41  <qbk>[include reference/algorithms/num_interior_rings.qbk]</qbk> </para><para><simplesect kind="note"><para>Defined by OGC as &quot;numInteriorRing&quot;. To be consistent with &quot;numPoints&quot; letter &quot;s&quot; is appended </para></simplesect>
  42 </para>        </detaileddescription>
  43         <inbodydescription>
  44         </inbodydescription>
  45         <location file="/home/ubuntu/boost/boost/geometry/algorithms/num_interior_rings.hpp" line="133" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/num_interior_rings.hpp" bodystart="133" bodyend="136"/>
  46       </memberdef>
  47       </sectiondef>
  48     <briefdescription>
  49     </briefdescription>
  50     <detaileddescription>
  51     </detaileddescription>
  52   </compounddef>
  53 </doxygen>