libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1multi__point.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="classboost_1_1geometry_1_1model_1_1multi__point" kind="class" prot="public">
   4     <compoundname>boost::geometry::model::multi_point</compoundname>
   5     <basecompoundref prot="public" virt="non-virtual">Container&lt; Point, Allocator&lt; Point &gt; &gt;</basecompoundref>
   6     <includes local="no">multi_point.hpp</includes>
   7     <templateparamlist>
   8       <param>
   9         <type>typename Point</type>
  10       </param>
  11       <param>
  12         <type>template&lt; typename, typename &gt; class</type>
  13         <declname>Container</declname>
  14         <defname>Container</defname>
  15         <defval>std::vector</defval>
  16       </param>
  17       <param>
  18         <type>template&lt; typename &gt; class</type>
  19         <declname>Allocator</declname>
  20         <defname>Allocator</defname>
  21         <defval>std::allocator</defval>
  22       </param>
  23     </templateparamlist>
  24       <sectiondef kind="private-type">
  25       <memberdef kind="typedef" id="classboost_1_1geometry_1_1model_1_1multi__point_1a9a096eb72a510dc0373937557652dd5e" prot="private" static="no">
  26         <type>Container&lt; Point, Allocator&lt; Point &gt; &gt;</type>
  27         <definition>typedef Container&lt;Point, Allocator&lt;Point&gt; &gt; boost::geometry::model::multi_point&lt; Point, Container, Allocator &gt;::base_type</definition>
  28         <argsstring></argsstring>
  29         <name>base_type</name>
  30         <briefdescription>
  31         </briefdescription>
  32         <detaileddescription>
  33         </detaileddescription>
  34         <inbodydescription>
  35         </inbodydescription>
  36         <location file="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" line="63" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" bodystart="63" bodyend="-1"/>
  37       </memberdef>
  38       </sectiondef>
  39       <sectiondef kind="private-func">
  40       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1multi__point_1aaa60521babc62f517d0b1245d1d0448b" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
  41         <type></type>
  42         <definition>boost::geometry::model::multi_point&lt; Point, Container, Allocator &gt;::BOOST_CONCEPT_ASSERT</definition>
  43         <argsstring>((concepts::Point&lt; Point &gt;))</argsstring>
  44         <name>BOOST_CONCEPT_ASSERT</name>
  45         <param>
  46           <type>(<ref refid="classboost_1_1geometry_1_1concepts_1_1_point" kindref="compound">concepts::Point</ref>&lt; Point &gt;)</type>
  47         </param>
  48         <briefdescription>
  49         </briefdescription>
  50         <detaileddescription>
  51         </detaileddescription>
  52         <inbodydescription>
  53         </inbodydescription>
  54         <location file="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" line="61" column="1"/>
  55       </memberdef>
  56       </sectiondef>
  57       <sectiondef kind="public-func">
  58       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1multi__point_1abae1e4f6c1338a8393af93e338a5556d" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  59         <type></type>
  60         <definition>boost::geometry::model::multi_point&lt; Point, Container, Allocator &gt;::multi_point</definition>
  61         <argsstring>()</argsstring>
  62         <name>multi_point</name>
  63         <briefdescription>
  64 <para>Default constructor, creating an empty <ref refid="classboost_1_1geometry_1_1model_1_1multi__point" kindref="compound">multi_point</ref>. </para>        </briefdescription>
  65         <detaileddescription>
  66         </detaileddescription>
  67         <inbodydescription>
  68         </inbodydescription>
  69         <location file="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" line="67" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" bodystart="67" bodyend="69"/>
  70       </memberdef>
  71       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1multi__point_1ab51375b0136afafeb08adfac0817fbf8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  72         <templateparamlist>
  73           <param>
  74             <type>typename Iterator</type>
  75           </param>
  76         </templateparamlist>
  77         <type></type>
  78         <definition>boost::geometry::model::multi_point&lt; Point, Container, Allocator &gt;::multi_point</definition>
  79         <argsstring>(Iterator begin, Iterator end)</argsstring>
  80         <name>multi_point</name>
  81         <param>
  82           <type>Iterator</type>
  83           <declname>begin</declname>
  84         </param>
  85         <param>
  86           <type>Iterator</type>
  87           <declname>end</declname>
  88         </param>
  89         <briefdescription>
  90 <para>Constructor with begin and end, filling the <ref refid="classboost_1_1geometry_1_1model_1_1multi__point" kindref="compound">multi_point</ref>. </para>        </briefdescription>
  91         <detaileddescription>
  92         </detaileddescription>
  93         <inbodydescription>
  94         </inbodydescription>
  95         <location file="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" line="73" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" bodystart="73" bodyend="75"/>
  96       </memberdef>
  97       <memberdef kind="function" id="classboost_1_1geometry_1_1model_1_1multi__point_1a0052f6896ee5cb0d9c6a06f0b90c5392" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  98         <type></type>
  99         <definition>boost::geometry::model::multi_point&lt; Point, Container, Allocator &gt;::multi_point</definition>
 100         <argsstring>(std::initializer_list&lt; Point &gt; l)</argsstring>
 101         <name>multi_point</name>
 102         <param>
 103           <type>std::initializer_list&lt; Point &gt;</type>
 104           <declname>l</declname>
 105         </param>
 106         <briefdescription>
 107 <para>Constructor taking std::initializer_list, filling the <ref refid="classboost_1_1geometry_1_1model_1_1multi__point" kindref="compound">multi_point</ref>. </para>        </briefdescription>
 108         <detaileddescription>
 109         </detaileddescription>
 110         <inbodydescription>
 111         </inbodydescription>
 112         <location file="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" line="80" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" bodystart="80" bodyend="82"/>
 113       </memberdef>
 114       </sectiondef>
 115     <briefdescription>
 116 <para><ref refid="classboost_1_1geometry_1_1model_1_1multi__point" kindref="compound">multi_point</ref>, a collection of points </para>    </briefdescription>
 117     <detaileddescription>
 118 <para><parameterlist kind="templateparam"><parameteritem>
 119 <parameternamelist>
 120 <parametername>Point</parametername>
 121 </parameternamelist>
 122 <parameterdescription>
 123 <para>Any type fulfilling a Point Concept </para></parameterdescription>
 124 </parameteritem>
 125 <parameteritem>
 126 <parameternamelist>
 127 <parametername>Container</parametername>
 128 </parameternamelist>
 129 <parameterdescription>
 130 <para>container type, for example std::vector, std::deque </para></parameterdescription>
 131 </parameteritem>
 132 <parameteritem>
 133 <parameternamelist>
 134 <parametername>Allocator</parametername>
 135 </parameternamelist>
 136 <parameterdescription>
 137 <para>container-allocator-type</para></parameterdescription>
 138 </parameteritem>
 139 </parameterlist>
 140 Multipoint can be used to group points belonging to each other, e.g. a constellation, or the result set of an intersection</para><para> <qbk>[include reference/geometries/multi_point.qbk]</qbk>   <qbk.before.synopsis>
 141 [heading Model of]
 142 [link geometry.reference.concepts.concept_multi_point MultiPoint Concept]
 143 </qbk.before.synopsis>  </para>    </detaileddescription>
 144     <inheritancegraph>
 145       <node id="501">
 146         <label>Container&lt; Point, Allocator&lt; Point &gt; &gt;</label>
 147       </node>
 148       <node id="500">
 149         <label>boost::geometry::model::multi_point&lt; Point, Container, Allocator &gt;</label>
 150         <link refid="classboost_1_1geometry_1_1model_1_1multi__point"/>
 151         <childnode refid="501" relation="public-inheritance">
 152         </childnode>
 153       </node>
 154     </inheritancegraph>
 155     <collaborationgraph>
 156       <node id="503">
 157         <label>Container&lt; Point, Allocator&lt; Point &gt; &gt;</label>
 158       </node>
 159       <node id="502">
 160         <label>boost::geometry::model::multi_point&lt; Point, Container, Allocator &gt;</label>
 161         <link refid="classboost_1_1geometry_1_1model_1_1multi__point"/>
 162         <childnode refid="503" relation="public-inheritance">
 163         </childnode>
 164       </node>
 165     </collaborationgraph>
 166     <location file="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" line="60" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/geometries/multi_point.hpp" bodystart="59" bodyend="98"/>
 167     <listofallmembers>
 168       <member refid="classboost_1_1geometry_1_1model_1_1multi__point_1a9a096eb72a510dc0373937557652dd5e" prot="private" virt="non-virtual"><scope>boost::geometry::model::multi_point</scope><name>base_type</name></member>
 169       <member refid="classboost_1_1geometry_1_1model_1_1multi__point_1aaa60521babc62f517d0b1245d1d0448b" prot="private" virt="non-virtual"><scope>boost::geometry::model::multi_point</scope><name>BOOST_CONCEPT_ASSERT</name></member>
 170       <member refid="classboost_1_1geometry_1_1model_1_1multi__point_1abae1e4f6c1338a8393af93e338a5556d" prot="public" virt="non-virtual"><scope>boost::geometry::model::multi_point</scope><name>multi_point</name></member>
 171       <member refid="classboost_1_1geometry_1_1model_1_1multi__point_1ab51375b0136afafeb08adfac0817fbf8" prot="public" virt="non-virtual"><scope>boost::geometry::model::multi_point</scope><name>multi_point</name></member>
 172       <member refid="classboost_1_1geometry_1_1model_1_1multi__point_1a0052f6896ee5cb0d9c6a06f0b90c5392" prot="public" virt="non-virtual"><scope>boost::geometry::model::multi_point</scope><name>multi_point</name></member>
 173     </listofallmembers>
 174   </compounddef>
 175 </doxygen>