libs/geometry/doc/doxy/doxygen_output/xml/group__num__points.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__points" kind="group">
   4     <compoundname>num_points</compoundname>
   5     <title>number of points: calculate number of points of a geometry</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__num__points_1ga4e90b249b3cf16e4ef8f486df042aacd" 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_points</definition>
  15         <argsstring>(Geometry const &amp;geometry, bool add_for_open=false)</argsstring>
  16         <name>num_points</name>
  17         <param>
  18           <type>Geometry const &amp;</type>
  19           <declname>geometry</declname>
  20         </param>
  21         <param>
  22           <type>bool</type>
  23           <declname>add_for_open</declname>
  24           <defval>false</defval>
  25         </param>
  26         <briefdescription>
  27 <para>Calculates the number of points of a geometry. </para>        </briefdescription>
  28         <detaileddescription>
  29 <para>The free function num_points calculates the number of points of a geometry. <parameterlist kind="templateparam"><parameteritem>
  30 <parameternamelist>
  31 <parametername>Geometry</parametername>
  32 </parameternamelist>
  33 <parameterdescription>
  34 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  35 </parameteritem>
  36 </parameterlist>
  37 <parameterlist kind="param"><parameteritem>
  38 <parameternamelist>
  39 <parametername>geometry</parametername>
  40 </parameternamelist>
  41 <parameterdescription>
  42 <para>A model of the specified concept </para></parameterdescription>
  43 </parameteritem>
  44 <parameteritem>
  45 <parameternamelist>
  46 <parametername>add_for_open</parametername>
  47 </parameternamelist>
  48 <parameterdescription>
  49 <para>add one for open geometries (i.e. polygon types which are not closed) </para></parameterdescription>
  50 </parameteritem>
  51 </parameterlist>
  52 <simplesect kind="return"><para>The calculated number of points</para></simplesect>
  53  <qbk>[include reference/algorithms/num_points.qbk]</qbk>  </para>        </detaileddescription>
  54         <inbodydescription>
  55         </inbodydescription>
  56         <location file="/home/ubuntu/boost/boost/geometry/algorithms/num_points.hpp" line="199" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/num_points.hpp" bodystart="199" bodyend="202"/>
  57       </memberdef>
  58       </sectiondef>
  59     <briefdescription>
  60     </briefdescription>
  61     <detaileddescription>
  62     </detaileddescription>
  63   </compounddef>
  64 </doxygen>