libs/geometry/doc/doxy/doxygen_output/xml/group__clear.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__clear" kind="group">
   4     <compoundname>clear</compoundname>
   5     <title>clear: clear geometries</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__clear_1ga61147247703a55d2d81badbd7f0a12a9" 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>void</type>
  14         <definition>void boost::geometry::clear</definition>
  15         <argsstring>(Geometry &amp;geometry)</argsstring>
  16         <name>clear</name>
  17         <param>
  18           <type>Geometry &amp;</type>
  19           <declname>geometry</declname>
  20         </param>
  21         <briefdescription>
  22 <para>Clears a linestring, ring or polygon (exterior+interiors) or multi*. </para>        </briefdescription>
  23         <detaileddescription>
  24 <para>Generic function to clear a geometry. All points will be removed from the collection or collections making up the geometry. In most cases this is equivalent to the .<ref refid="group__clear_1ga61147247703a55d2d81badbd7f0a12a9" kindref="member">clear()</ref> method of a std::vector&lt;...&gt;. In the case of a polygon, this clear functionality is automatically called for the exterior ring, and for the interior ring collection. In the case of a point, boxes and segments, nothing will happen.</para><para><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 which will be cleared </para></parameterdescription>
  38 </parameteritem>
  39 </parameterlist>
  40 <simplesect kind="note"><para>points and boxes cannot be cleared, instead they can be set to zero by &quot;assign_zero&quot;</para></simplesect>
  41  <qbk>[include reference/algorithms/clear.qbk]</qbk>  </para>        </detaileddescription>
  42         <inbodydescription>
  43         </inbodydescription>
  44         <location file="/home/ubuntu/boost/boost/geometry/algorithms/clear.hpp" line="186" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/clear.hpp" bodystart="186" bodyend="191"/>
  45       </memberdef>
  46       </sectiondef>
  47     <briefdescription>
  48     </briefdescription>
  49     <detaileddescription>
  50     </detaileddescription>
  51   </compounddef>
  52 </doxygen>