libs/geometry/doc/doxy/doxygen_output/xml/structboost_1_1geometry_1_1ever__circling__range__iterator.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_1ever__circling__range__iterator" kind="struct" prot="public">
   4     <compoundname>boost::geometry::ever_circling_range_iterator</compoundname>
   5     <basecompoundref prot="public" virt="non-virtual">boost::iterator_facade&lt; ever_circling_range_iterator&lt; Range &gt;, boost::range_value&lt; Range &gt;::type const, boost::random_access_traversal_tag &gt;</basecompoundref>
   6     <includes local="no">ever_circling_iterator.hpp</includes>
   7     <templateparamlist>
   8       <param>
   9         <type>typename Range</type>
  10       </param>
  11     </templateparamlist>
  12       <sectiondef kind="public-type">
  13       <memberdef kind="typedef" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1a82d2ca373c02492ce0cfbaaf211395d2" prot="public" static="no">
  14         <type>std::ptrdiff_t</type>
  15         <definition>typedef std::ptrdiff_t boost::geometry::ever_circling_range_iterator&lt; Range &gt;::difference_type</definition>
  16         <argsstring></argsstring>
  17         <name>difference_type</name>
  18         <briefdescription>
  19         </briefdescription>
  20         <detaileddescription>
  21         </detaileddescription>
  22         <inbodydescription>
  23         </inbodydescription>
  24         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="122" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="122" bodyend="-1"/>
  25       </memberdef>
  26       </sectiondef>
  27       <sectiondef kind="friend">
  28       <memberdef kind="friend" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1ac09f73e325921cc50ebcd96bed0f8096" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
  29         <type>friend class</type>
  30         <definition>friend class boost::iterator_core_access</definition>
  31         <argsstring></argsstring>
  32         <name>boost::iterator_core_access</name>
  33         <briefdescription>
  34         </briefdescription>
  35         <detaileddescription>
  36         </detaileddescription>
  37         <inbodydescription>
  38         </inbodydescription>
  39         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="125" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="125" bodyend="-1"/>
  40       </memberdef>
  41       </sectiondef>
  42       <sectiondef kind="private-attrib">
  43       <memberdef kind="variable" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1acfd90a2795255e3d157d789830e4e05f" prot="private" static="no" mutable="no">
  44         <type><ref refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a82d2ca373c02492ce0cfbaaf211395d2" kindref="member">difference_type</ref></type>
  45         <definition>difference_type boost::geometry::ever_circling_range_iterator&lt; Range &gt;::m_index</definition>
  46         <argsstring></argsstring>
  47         <name>m_index</name>
  48         <briefdescription>
  49         </briefdescription>
  50         <detaileddescription>
  51         </detaileddescription>
  52         <inbodydescription>
  53         </inbodydescription>
  54         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="197" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="197" bodyend="-1"/>
  55       </memberdef>
  56       <memberdef kind="variable" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1a76a23948859395039aba3b0ec44dbf5b" prot="private" static="no" mutable="no">
  57         <type>boost::range_iterator&lt; Range &gt;::type</type>
  58         <definition>boost::range_iterator&lt;Range&gt;::type boost::geometry::ever_circling_range_iterator&lt; Range &gt;::m_iterator</definition>
  59         <argsstring></argsstring>
  60         <name>m_iterator</name>
  61         <briefdescription>
  62         </briefdescription>
  63         <detaileddescription>
  64         </detaileddescription>
  65         <inbodydescription>
  66         </inbodydescription>
  67         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="195" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="195" bodyend="-1"/>
  68       </memberdef>
  69       <memberdef kind="variable" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1abeb976f04ed2d060141ed93be1808210" prot="private" static="no" mutable="no">
  70         <type>Range *</type>
  71         <definition>Range* boost::geometry::ever_circling_range_iterator&lt; Range &gt;::m_range</definition>
  72         <argsstring></argsstring>
  73         <name>m_range</name>
  74         <briefdescription>
  75         </briefdescription>
  76         <detaileddescription>
  77         </detaileddescription>
  78         <inbodydescription>
  79         </inbodydescription>
  80         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="194" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="194" bodyend="-1"/>
  81       </memberdef>
  82       <memberdef kind="variable" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1a61a4befa7b792c370a8b98292b8ee396" prot="private" static="no" mutable="no">
  83         <type><ref refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a82d2ca373c02492ce0cfbaaf211395d2" kindref="member">difference_type</ref></type>
  84         <definition>difference_type boost::geometry::ever_circling_range_iterator&lt; Range &gt;::m_size</definition>
  85         <argsstring></argsstring>
  86         <name>m_size</name>
  87         <briefdescription>
  88         </briefdescription>
  89         <detaileddescription>
  90         </detaileddescription>
  91         <inbodydescription>
  92         </inbodydescription>
  93         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="196" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="196" bodyend="-1"/>
  94       </memberdef>
  95       </sectiondef>
  96       <sectiondef kind="public-func">
  97       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1a8599ed13873fd8cc18520a7998e4da28" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
  98         <type></type>
  99         <definition>boost::geometry::ever_circling_range_iterator&lt; Range &gt;::ever_circling_range_iterator</definition>
 100         <argsstring>(Range &amp;range)</argsstring>
 101         <name>ever_circling_range_iterator</name>
 102         <param>
 103           <type>Range &amp;</type>
 104           <declname>range</declname>
 105         </param>
 106         <briefdescription>
 107 <para>Constructor including the range it is based on. </para>        </briefdescription>
 108         <detaileddescription>
 109         </detaileddescription>
 110         <inbodydescription>
 111         </inbodydescription>
 112         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="108" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="108" bodyend="113"/>
 113       </memberdef>
 114       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1ad0458fea280e5903b7f733961a5b7664" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
 115         <type></type>
 116         <definition>boost::geometry::ever_circling_range_iterator&lt; Range &gt;::ever_circling_range_iterator</definition>
 117         <argsstring>()</argsstring>
 118         <name>ever_circling_range_iterator</name>
 119         <briefdescription>
 120 <para>Default constructor. </para>        </briefdescription>
 121         <detaileddescription>
 122         </detaileddescription>
 123         <inbodydescription>
 124         </inbodydescription>
 125         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="116" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="116" bodyend="120"/>
 126       </memberdef>
 127       </sectiondef>
 128       <sectiondef kind="private-func">
 129       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1a0ac146b5445ac6119a13c2a2ca1bbd9c" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 130         <type>void</type>
 131         <definition>void boost::geometry::ever_circling_range_iterator&lt; Range &gt;::advance</definition>
 132         <argsstring>(difference_type n)</argsstring>
 133         <name>advance</name>
 134         <param>
 135           <type><ref refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a82d2ca373c02492ce0cfbaaf211395d2" kindref="member">difference_type</ref></type>
 136           <declname>n</declname>
 137         </param>
 138         <briefdescription>
 139         </briefdescription>
 140         <detaileddescription>
 141         </detaileddescription>
 142         <inbodydescription>
 143         </inbodydescription>
 144         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="169" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="169" bodyend="182"/>
 145       </memberdef>
 146       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1aa741c21b7642994a2b8e38462d5d2cf6" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 147         <type>void</type>
 148         <definition>void boost::geometry::ever_circling_range_iterator&lt; Range &gt;::decrement</definition>
 149         <argsstring>()</argsstring>
 150         <name>decrement</name>
 151         <briefdescription>
 152         </briefdescription>
 153         <detaileddescription>
 154         </detaileddescription>
 155         <inbodydescription>
 156         </inbodydescription>
 157         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="156" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="156" bodyend="167"/>
 158       </memberdef>
 159       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1a6f6565421dc3fe38c8c8e321d74cdbcb" prot="private" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
 160         <type>boost::range_value&lt; Range &gt;::type const &amp;</type>
 161         <definition>boost::range_value&lt;Range&gt;::type const&amp; boost::geometry::ever_circling_range_iterator&lt; Range &gt;::dereference</definition>
 162         <argsstring>() const </argsstring>
 163         <name>dereference</name>
 164         <briefdescription>
 165         </briefdescription>
 166         <detaileddescription>
 167         </detaileddescription>
 168         <inbodydescription>
 169         </inbodydescription>
 170         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="127" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="127" bodyend="130"/>
 171       </memberdef>
 172       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1aa3f2baadd0bd0642ae58767d7837b047" prot="private" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
 173         <type><ref refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a82d2ca373c02492ce0cfbaaf211395d2" kindref="member">difference_type</ref></type>
 174         <definition>difference_type boost::geometry::ever_circling_range_iterator&lt; Range &gt;::distance_to</definition>
 175         <argsstring>(ever_circling_range_iterator&lt; Range &gt; const &amp;other) const </argsstring>
 176         <name>distance_to</name>
 177         <param>
 178           <type><ref refid="structboost_1_1geometry_1_1ever__circling__range__iterator" kindref="compound">ever_circling_range_iterator</ref>&lt; Range &gt; const &amp;</type>
 179           <declname>other</declname>
 180         </param>
 181         <briefdescription>
 182         </briefdescription>
 183         <detaileddescription>
 184         </detaileddescription>
 185         <inbodydescription>
 186         </inbodydescription>
 187         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="132" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="132" bodyend="135"/>
 188       </memberdef>
 189       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1af90f510fd42ac0391e06dfeaae2a83b5" prot="private" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
 190         <type>bool</type>
 191         <definition>bool boost::geometry::ever_circling_range_iterator&lt; Range &gt;::equal</definition>
 192         <argsstring>(ever_circling_range_iterator&lt; Range &gt; const &amp;other) const </argsstring>
 193         <name>equal</name>
 194         <param>
 195           <type><ref refid="structboost_1_1geometry_1_1ever__circling__range__iterator" kindref="compound">ever_circling_range_iterator</ref>&lt; Range &gt; const &amp;</type>
 196           <declname>other</declname>
 197         </param>
 198         <briefdescription>
 199         </briefdescription>
 200         <detaileddescription>
 201         </detaileddescription>
 202         <inbodydescription>
 203         </inbodydescription>
 204         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="137" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="137" bodyend="141"/>
 205       </memberdef>
 206       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1aae680df8d0682c6b50eb7fa02c61236c" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 207         <type>void</type>
 208         <definition>void boost::geometry::ever_circling_range_iterator&lt; Range &gt;::increment</definition>
 209         <argsstring>()</argsstring>
 210         <name>increment</name>
 211         <briefdescription>
 212         </briefdescription>
 213         <detaileddescription>
 214         </detaileddescription>
 215         <inbodydescription>
 216         </inbodydescription>
 217         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="143" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="143" bodyend="154"/>
 218       </memberdef>
 219       <memberdef kind="function" id="structboost_1_1geometry_1_1ever__circling__range__iterator_1a9bbe6e4c0f8b403f43925ff868de0239" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
 220         <type>void</type>
 221         <definition>void boost::geometry::ever_circling_range_iterator&lt; Range &gt;::update_iterator</definition>
 222         <argsstring>()</argsstring>
 223         <name>update_iterator</name>
 224         <briefdescription>
 225         </briefdescription>
 226         <detaileddescription>
 227         </detaileddescription>
 228         <inbodydescription>
 229         </inbodydescription>
 230         <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="184" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="184" bodyend="192"/>
 231       </memberdef>
 232       </sectiondef>
 233     <briefdescription>
 234     </briefdescription>
 235     <detaileddescription>
 236     </detaileddescription>
 237     <inheritancegraph>
 238       <node id="355">
 239         <label>boost::geometry::ever_circling_range_iterator&lt; Range &gt;</label>
 240         <link refid="structboost_1_1geometry_1_1ever__circling__range__iterator"/>
 241         <childnode refid="356" relation="public-inheritance">
 242         </childnode>
 243       </node>
 244       <node id="356">
 245         <label>boost::iterator_facade&lt; ever_circling_range_iterator&lt; Range &gt;, boost::range_value&lt; Range &gt;::type const, boost::random_access_traversal_tag &gt;</label>
 246       </node>
 247     </inheritancegraph>
 248     <collaborationgraph>
 249       <node id="357">
 250         <label>boost::geometry::ever_circling_range_iterator&lt; Range &gt;</label>
 251         <link refid="structboost_1_1geometry_1_1ever__circling__range__iterator"/>
 252         <childnode refid="358" relation="public-inheritance">
 253         </childnode>
 254       </node>
 255       <node id="358">
 256         <label>boost::iterator_facade&lt; ever_circling_range_iterator&lt; Range &gt;, boost::range_value&lt; Range &gt;::type const, boost::random_access_traversal_tag &gt;</label>
 257       </node>
 258     </collaborationgraph>
 259     <location file="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" line="106" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/iterators/ever_circling_iterator.hpp" bodystart="99" bodyend="198"/>
 260     <listofallmembers>
 261       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a0ac146b5445ac6119a13c2a2ca1bbd9c" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>advance</name></member>
 262       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1ac09f73e325921cc50ebcd96bed0f8096" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>boost::iterator_core_access</name></member>
 263       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1aa741c21b7642994a2b8e38462d5d2cf6" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>decrement</name></member>
 264       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a6f6565421dc3fe38c8c8e321d74cdbcb" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>dereference</name></member>
 265       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a82d2ca373c02492ce0cfbaaf211395d2" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>difference_type</name></member>
 266       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1aa3f2baadd0bd0642ae58767d7837b047" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>distance_to</name></member>
 267       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1af90f510fd42ac0391e06dfeaae2a83b5" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>equal</name></member>
 268       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a8599ed13873fd8cc18520a7998e4da28" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>ever_circling_range_iterator</name></member>
 269       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1ad0458fea280e5903b7f733961a5b7664" prot="public" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>ever_circling_range_iterator</name></member>
 270       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1aae680df8d0682c6b50eb7fa02c61236c" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>increment</name></member>
 271       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1acfd90a2795255e3d157d789830e4e05f" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>m_index</name></member>
 272       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a76a23948859395039aba3b0ec44dbf5b" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>m_iterator</name></member>
 273       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1abeb976f04ed2d060141ed93be1808210" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>m_range</name></member>
 274       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a61a4befa7b792c370a8b98292b8ee396" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>m_size</name></member>
 275       <member refid="structboost_1_1geometry_1_1ever__circling__range__iterator_1a9bbe6e4c0f8b403f43925ff868de0239" prot="private" virt="non-virtual"><scope>boost::geometry::ever_circling_range_iterator</scope><name>update_iterator</name></member>
 276     </listofallmembers>
 277   </compounddef>
 278 </doxygen>