libs/geometry/doc/index/xml/structboost_1_1geometry_1_1index_1_1rstar.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="structboost_1_1geometry_1_1index_1_1rstar" kind="struct" prot="public">
   4     <compoundname>boost::geometry::index::rstar</compoundname>
   5     <includes refid="parameters_8hpp" local="no">parameters.hpp</includes>
   6     <templateparamlist>
   7       <param>
   8         <type>size_t</type>
   9         <declname>MaxElements</declname>
  10         <defname>MaxElements</defname>
  11       </param>
  12       <param>
  13         <type>size_t</type>
  14         <declname>MinElements</declname>
  15         <defname>MinElements</defname>
  16         <defval>detail::default_min_elements_s&lt;MaxElements&gt;::value</defval>
  17       </param>
  18       <param>
  19         <type>size_t</type>
  20         <declname>ReinsertedElements</declname>
  21         <defname>ReinsertedElements</defname>
  22         <defval>detail::default_rstar_reinserted_elements_s&lt;MaxElements&gt;::value</defval>
  23       </param>
  24       <param>
  25         <type>size_t</type>
  26         <declname>OverlapCostThreshold</declname>
  27         <defname>OverlapCostThreshold</defname>
  28         <defval>32</defval>
  29       </param>
  30     </templateparamlist>
  31       <sectiondef kind="public-static-attrib">
  32       <memberdef kind="variable" id="structboost_1_1geometry_1_1index_1_1rstar_1a95a7115404848fce8d09bb2b42271cd0" prot="public" static="yes" mutable="no">
  33         <type>const size_t</type>
  34         <definition>const size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::max_elements</definition>
  35         <argsstring></argsstring>
  36         <name>max_elements</name>
  37         <initializer>= MaxElements</initializer>
  38         <briefdescription>
  39         </briefdescription>
  40         <detaileddescription>
  41         </detaileddescription>
  42         <inbodydescription>
  43         </inbodydescription>
  44         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="129" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="129" bodyend="-1"/>
  45       </memberdef>
  46       <memberdef kind="variable" id="structboost_1_1geometry_1_1index_1_1rstar_1a2b1dbc3eb46a97257b2c80650cf31abe" prot="public" static="yes" mutable="no">
  47         <type>const size_t</type>
  48         <definition>const size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::min_elements</definition>
  49         <argsstring></argsstring>
  50         <name>min_elements</name>
  51         <initializer>= MinElements</initializer>
  52         <briefdescription>
  53         </briefdescription>
  54         <detaileddescription>
  55         </detaileddescription>
  56         <inbodydescription>
  57         </inbodydescription>
  58         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="130" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="130" bodyend="-1"/>
  59       </memberdef>
  60       <memberdef kind="variable" id="structboost_1_1geometry_1_1index_1_1rstar_1ab1423e5c0fc461db5490af15b8fb4483" prot="public" static="yes" mutable="no">
  61         <type>const size_t</type>
  62         <definition>const size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::reinserted_elements</definition>
  63         <argsstring></argsstring>
  64         <name>reinserted_elements</name>
  65         <initializer>= ReinsertedElements</initializer>
  66         <briefdescription>
  67         </briefdescription>
  68         <detaileddescription>
  69         </detaileddescription>
  70         <inbodydescription>
  71         </inbodydescription>
  72         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="131" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="131" bodyend="-1"/>
  73       </memberdef>
  74       <memberdef kind="variable" id="structboost_1_1geometry_1_1index_1_1rstar_1a168a5cc1555cf598a35c6844443f27f1" prot="public" static="yes" mutable="no">
  75         <type>const size_t</type>
  76         <definition>const size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::overlap_cost_threshold</definition>
  77         <argsstring></argsstring>
  78         <name>overlap_cost_threshold</name>
  79         <initializer>= OverlapCostThreshold</initializer>
  80         <briefdescription>
  81         </briefdescription>
  82         <detaileddescription>
  83         </detaileddescription>
  84         <inbodydescription>
  85         </inbodydescription>
  86         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="132" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="132" bodyend="-1"/>
  87       </memberdef>
  88       </sectiondef>
  89       <sectiondef kind="public-func">
  90       <memberdef kind="function" id="structboost_1_1geometry_1_1index_1_1rstar_1a265a4b8112f7ed2f32e3010ef2cd0cf0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
  91         <type></type>
  92         <definition>boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::BOOST_MPL_ASSERT_MSG</definition>
  93         <argsstring>((0&lt; MinElements &amp;&amp;2 *MinElements&lt;=MaxElements+1), INVALID_STATIC_MIN_MAX_PARAMETERS,(rstar))</argsstring>
  94         <name>BOOST_MPL_ASSERT_MSG</name>
  95         <param>
  96           <type>(0&lt; MinElements &amp;&amp;2 *MinElements&lt;=MaxElements+1)</type>
  97         </param>
  98         <param>
  99           <type>INVALID_STATIC_MIN_MAX_PARAMETERS</type>
 100         </param>
 101         <param>
 102           <type>(<ref refid="structboost_1_1geometry_1_1index_1_1rstar" kindref="compound">rstar</ref>)</type>
 103         </param>
 104         <briefdescription>
 105         </briefdescription>
 106         <detaileddescription>
 107         </detaileddescription>
 108         <inbodydescription>
 109         </inbodydescription>
 110         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="126" column="1"/>
 111       </memberdef>
 112       </sectiondef>
 113       <sectiondef kind="public-static-func">
 114       <memberdef kind="function" id="structboost_1_1geometry_1_1index_1_1rstar_1a3256c967833680dc205c32a999e6920d" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
 115         <type>size_t</type>
 116         <definition>static size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::get_max_elements</definition>
 117         <argsstring>()</argsstring>
 118         <name>get_max_elements</name>
 119         <briefdescription>
 120         </briefdescription>
 121         <detaileddescription>
 122         </detaileddescription>
 123         <inbodydescription>
 124         </inbodydescription>
 125         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="134" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="134" bodyend="134"/>
 126       </memberdef>
 127       <memberdef kind="function" id="structboost_1_1geometry_1_1index_1_1rstar_1afc2516f278b3a75871a22cb559ed9a4f" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
 128         <type>size_t</type>
 129         <definition>static size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::get_min_elements</definition>
 130         <argsstring>()</argsstring>
 131         <name>get_min_elements</name>
 132         <briefdescription>
 133         </briefdescription>
 134         <detaileddescription>
 135         </detaileddescription>
 136         <inbodydescription>
 137         </inbodydescription>
 138         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="135" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="135" bodyend="135"/>
 139       </memberdef>
 140       <memberdef kind="function" id="structboost_1_1geometry_1_1index_1_1rstar_1a7561bb5427a6db5cbec4894a49dd8c9f" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
 141         <type>size_t</type>
 142         <definition>static size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::get_reinserted_elements</definition>
 143         <argsstring>()</argsstring>
 144         <name>get_reinserted_elements</name>
 145         <briefdescription>
 146         </briefdescription>
 147         <detaileddescription>
 148         </detaileddescription>
 149         <inbodydescription>
 150         </inbodydescription>
 151         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="136" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="136" bodyend="136"/>
 152       </memberdef>
 153       <memberdef kind="function" id="structboost_1_1geometry_1_1index_1_1rstar_1ab1b41eb286b2396a836ad03b9c581c86" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
 154         <type>size_t</type>
 155         <definition>static size_t boost::geometry::index::rstar&lt; MaxElements, MinElements, ReinsertedElements, OverlapCostThreshold &gt;::get_overlap_cost_threshold</definition>
 156         <argsstring>()</argsstring>
 157         <name>get_overlap_cost_threshold</name>
 158         <briefdescription>
 159         </briefdescription>
 160         <detaileddescription>
 161         </detaileddescription>
 162         <inbodydescription>
 163         </inbodydescription>
 164         <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="137" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="137" bodyend="137"/>
 165       </memberdef>
 166       </sectiondef>
 167     <briefdescription>
 168 <para>R*-tree creation algorithm parameters. </para>    </briefdescription>
 169     <detaileddescription>
 170 <para><parameterlist kind="templateparam"><parameteritem>
 171 <parameternamelist>
 172 <parametername>MaxElements</parametername>
 173 </parameternamelist>
 174 <parameterdescription>
 175 <para>Maximum number of elements in nodes. </para></parameterdescription>
 176 </parameteritem>
 177 <parameteritem>
 178 <parameternamelist>
 179 <parametername>MinElements</parametername>
 180 </parameternamelist>
 181 <parameterdescription>
 182 <para>Minimum number of elements in nodes. Default: 0.3*Max. </para></parameterdescription>
 183 </parameteritem>
 184 <parameteritem>
 185 <parameternamelist>
 186 <parametername>ReinsertedElements</parametername>
 187 </parameternamelist>
 188 <parameterdescription>
 189 <para>The number of elements reinserted by forced reinsertions algorithm. If 0 forced reinsertions are disabled. Maximum value is Max+1-Min. Greater values are truncated. Default: 0.3*Max. </para></parameterdescription>
 190 </parameteritem>
 191 <parameteritem>
 192 <parameternamelist>
 193 <parametername>OverlapCostThreshold</parametername>
 194 </parameternamelist>
 195 <parameterdescription>
 196 <para>The number of most suitable leafs taken into account while choosing the leaf node to which currently inserted value will be added. If value is in range (0, MaxElements) - the algorithm calculates nearly minimum overlap cost, otherwise all leafs are analyzed and true minimum overlap cost is calculated. Default: 32. </para></parameterdescription>
 197 </parameteritem>
 198 </parameterlist>
 199 </para>    </detaileddescription>
 200     <location file="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" line="125" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/index/parameters.hpp" bodystart="124" bodyend="138"/>
 201     <listofallmembers>
 202       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1a265a4b8112f7ed2f32e3010ef2cd0cf0" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>BOOST_MPL_ASSERT_MSG</name></member>
 203       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1a3256c967833680dc205c32a999e6920d" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>get_max_elements</name></member>
 204       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1afc2516f278b3a75871a22cb559ed9a4f" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>get_min_elements</name></member>
 205       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1ab1b41eb286b2396a836ad03b9c581c86" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>get_overlap_cost_threshold</name></member>
 206       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1a7561bb5427a6db5cbec4894a49dd8c9f" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>get_reinserted_elements</name></member>
 207       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1a95a7115404848fce8d09bb2b42271cd0" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>max_elements</name></member>
 208       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1a2b1dbc3eb46a97257b2c80650cf31abe" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>min_elements</name></member>
 209       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1a168a5cc1555cf598a35c6844443f27f1" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>overlap_cost_threshold</name></member>
 210       <member refid="structboost_1_1geometry_1_1index_1_1rstar_1ab1423e5c0fc461db5490af15b8fb4483" prot="public" virt="non-virtual"><scope>boost::geometry::index::rstar</scope><name>reinserted_elements</name></member>
 211     </listofallmembers>
 212   </compounddef>
 213 </doxygen>