Files
geometry/doc/doxygen_output/html/segment__iterator_8hpp_source.html
Barend Gehrels 363580fbf6 Added old doxygen docs
[SVN r59777]
2010-02-20 15:57:12 +00:00

204 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost.Geometry (aka GGL, Generic Geometry Library)</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<table cellpadding="2" width="100%">
<tbody>
<tr>
<td valign="top">
<img alt="Boost.Geometry" src="images/ggl-logo-big.png" height="80" width="200">
&nbsp;&nbsp;
</td>
<td valign="top" align="right">
<a href="http://www.boost.org">
<img alt="Boost C++ Libraries" src="images/accepted_by_boost.png" height="80" width="230" border="0">
</a>
</td>
</tr>
</tbody>
</table>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>boost/geometry/iterators/segment_iterator.hpp</h1><a href="segment__iterator_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Boost.Geometry (aka GGL, Generic Geometry Library)</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Copyright Barend Gehrels 2007-2009, Geodan, Amsterdam, the Netherlands.</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright Bruno Lalande 2008, 2009</span>
<a name="l00005"></a>00005 <span class="comment">// Copyright Mateusz Loskot 2009, mateusz@loskot.net</span>
<a name="l00006"></a>00006 <span class="comment">// Use, modification and distribution is subject to the Boost Software License,</span>
<a name="l00007"></a>00007 <span class="comment">// Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at</span>
<a name="l00008"></a>00008 <span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span>
<a name="l00009"></a>00009
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef BOOST_GEOMETRY_ITERATORS_SEGMENT_ITERATOR_HPP</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define BOOST_GEOMETRY_ITERATORS_SEGMENT_ITERATOR_HPP</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a>00013 <span class="comment">// TODO: This is very experimental version of input iterator</span>
<a name="l00014"></a>00014 <span class="comment">// reading collection of points as segments - proof of concept.</span>
<a name="l00015"></a>00015 <span class="comment">// --mloskot</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="comment">// TODO: Move to boost::iterator_adaptor</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;iterator&gt;</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;boost/assert.hpp&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;boost/iterator.hpp&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;boost/iterator/iterator_adaptor.hpp&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;boost/iterator/iterator_categories.hpp&gt;</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="equals_8hpp.html">boost/geometry/algorithms/equals.hpp</a>&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="segment_8hpp.html">boost/geometry/geometries/segment.hpp</a>&gt;</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>geometry
<a name="l00030"></a>00030 {
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Base, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>&gt;
<a name="l00033"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">00033</a> <span class="keyword">struct </span><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator</a>
<a name="l00034"></a>00034 {
<a name="l00035"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#be3c2b08341f6719cee013b449882aa6">00035</a> <span class="keyword">typedef</span> Base <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#be3c2b08341f6719cee013b449882aa6">base_type</a>;
<a name="l00036"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#47a6f253b51232228d177cc9ce735156">00036</a> <span class="keyword">typedef</span> Point <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>;
<a name="l00037"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#ae2db265def53c89226ff1fd23e5170a">00037</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="classboost_1_1geometry_1_1segment.html">geometry::segment&lt;Point&gt;</a> <a class="code" href="classboost_1_1geometry_1_1segment.html">segment_type</a>;
<a name="l00038"></a>00038
<a name="l00039"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#e4d2cefc789d367bb7d5cb96b1827681">00039</a> <span class="keyword">typedef</span> std::input_iterator_tag <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#e4d2cefc789d367bb7d5cb96b1827681">iterator_category</a>;
<a name="l00040"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#da82daeb26284d572138600ae2c65a18">00040</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> std::iterator_traits&lt;Base&gt;::difference_type <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#da82daeb26284d572138600ae2c65a18">difference_type</a>;
<a name="l00041"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#a8241938f5c3e60ed2d4081e9d672e95">00041</a> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1geometry_1_1segment.html">segment_type</a> <a class="code" href="classboost_1_1geometry_1_1segment.html">value_type</a>;
<a name="l00042"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#bbab7c3a4cabbd66f9c3ed0ccbe66fee">00042</a> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1geometry_1_1segment.html">segment_type</a>* <a class="code" href="classboost_1_1geometry_1_1segment.html">pointer</a>;
<a name="l00043"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#56fb21b68b9b57e31c04badc8fd8dc6e">00043</a> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1geometry_1_1segment.html">segment_type</a>&amp; <a class="code" href="classboost_1_1geometry_1_1segment.html">reference</a>;
<a name="l00044"></a>00044
<a name="l00045"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#8a23aab3f6d9f5ed0a4e67b5b7dc128f">00045</a> <span class="keyword">explicit</span> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#8a23aab3f6d9f5ed0a4e67b5b7dc128f">segment_iterator</a>(Base <span class="keyword">const</span>&amp; end)
<a name="l00046"></a>00046 : m_segment(p1 , p2)
<a name="l00047"></a>00047 , m_prev(end)
<a name="l00048"></a>00048 , m_it(end)
<a name="l00049"></a>00049 , m_end(end)
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 }
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#c759d27e50de7c6a7d92201be9cbb1c3">00053</a> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#8a23aab3f6d9f5ed0a4e67b5b7dc128f">segment_iterator</a>(Base <span class="keyword">const</span>&amp; it, Base <span class="keyword">const</span>&amp; end)
<a name="l00054"></a>00054 : m_segment(p1 , p2)
<a name="l00055"></a>00055 , m_prev(it)
<a name="l00056"></a>00056 , m_it(it)
<a name="l00057"></a>00057 , m_end(end)
<a name="l00058"></a>00058 {
<a name="l00059"></a>00059 <span class="keywordflow">if</span> (m_it != m_end)
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 BOOST_ASSERT(m_prev != m_end);
<a name="l00062"></a>00062 ++m_it;
<a name="l00063"></a>00063 }
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00066"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#9a3abff41d4647a1c5d2c4e0cf0f6c4e">00066</a> <a class="code" href="classboost_1_1geometry_1_1segment.html">reference</a> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#9a3abff41d4647a1c5d2c4e0cf0f6c4e">operator*</a>()
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 BOOST_ASSERT(m_it != m_end &amp;&amp; m_prev != m_end);
<a name="l00069"></a>00069
<a name="l00070"></a>00070 p1 = *m_prev;
<a name="l00071"></a>00071 p2 = *m_it;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordflow">return</span> m_segment;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00076"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#f5855165873ea4afd111a99e8d31eead">00076</a> <a class="code" href="classboost_1_1geometry_1_1segment.html">pointer</a> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#f5855165873ea4afd111a99e8d31eead">operator-&gt;</a>()
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="keywordflow">return</span> &amp;(<a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#9a3abff41d4647a1c5d2c4e0cf0f6c4e">operator*</a>());
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080
<a name="l00081"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#f80e13d3fb610106054448db70a353ff">00081</a> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator</a>&amp; <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#f80e13d3fb610106054448db70a353ff">operator++</a>()
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 ++m_prev;
<a name="l00084"></a>00084 ++m_it;
<a name="l00085"></a>00085 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#97eb8ddd5325aba907d577dd2bfd9d4b">00088</a> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator</a> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#f80e13d3fb610106054448db70a353ff">operator++</a>(<span class="keywordtype">int</span>)
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090 <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator</a> it(*<span class="keyword">this</span>);
<a name="l00091"></a>00091 ++(*this);
<a name="l00092"></a>00092 <span class="keywordflow">return</span> it;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094
<a name="l00095"></a><a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#bd8a36dce2df9d42752c6735ca98d773">00095</a> Base <span class="keyword">const</span>&amp; <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#bd8a36dce2df9d42752c6735ca98d773">base</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_it; }
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">private</span>:
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a> p1;
<a name="l00100"></a>00100 <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a> p2;
<a name="l00101"></a>00101 <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#ae2db265def53c89226ff1fd23e5170a">segment_type</a> m_segment;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 Base m_prev;
<a name="l00104"></a>00104 Base m_it;
<a name="l00105"></a>00105 Base m_end;
<a name="l00106"></a>00106 };
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Base, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>&gt;
<a name="l00109"></a><a class="code" href="namespaceboost_1_1geometry.html#92c4616022a5486f70482889b8f07327">00109</a> <span class="keywordtype">bool</span> <a class="code" href="namespaceboost_1_1geometry.html#92c4616022a5486f70482889b8f07327">operator==</a>(<a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator&lt;Base, Point&gt;</a> <span class="keyword">const</span>&amp; lhs,
<a name="l00110"></a>00110 <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator&lt;Base, Point&gt;</a> <span class="keyword">const</span>&amp; rhs)
<a name="l00111"></a>00111 {
<a name="l00112"></a>00112 <span class="keywordflow">return</span> (lhs.<a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#bd8a36dce2df9d42752c6735ca98d773">base</a>() == rhs.<a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#bd8a36dce2df9d42752c6735ca98d773">base</a>());
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> Base, <span class="keyword">typename</span> Po<span class="keywordtype">int</span>&gt;
<a name="l00116"></a><a class="code" href="namespaceboost_1_1geometry.html#2f1ccedb096dd54d4b021ed9048c8a64">00116</a> <span class="keywordtype">bool</span> <a class="code" href="namespaceboost_1_1geometry.html#2f1ccedb096dd54d4b021ed9048c8a64">operator!=</a>(<a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator&lt;Base, Point&gt;</a> <span class="keyword">const</span>&amp; lhs,
<a name="l00117"></a>00117 <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator&lt;Base, Point&gt;</a> <span class="keyword">const</span>&amp; rhs)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="keywordflow">return</span> (lhs.<a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#bd8a36dce2df9d42752c6735ca98d773">base</a>() != rhs.<a class="code" href="structboost_1_1geometry_1_1segment__iterator.html#bd8a36dce2df9d42752c6735ca98d773">base</a>());
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> C&gt;
<a name="l00123"></a>00123 segment_iterator
<a name="l00124"></a>00124 &lt;
<a name="l00125"></a>00125 <span class="keyword">typename</span> C::iterator,
<a name="l00126"></a>00126 <span class="keyword">typename</span> C::value_type
<a name="l00127"></a>00127 &gt;
<a name="l00128"></a><a class="code" href="namespaceboost_1_1geometry.html#d035e6073d945ea080a3d5e8adf3a38c">00128</a> <a class="code" href="namespaceboost_1_1geometry.html#d035e6073d945ea080a3d5e8adf3a38c">make_segment_iterator</a>(C&amp; c)
<a name="l00129"></a>00129 {
<a name="l00130"></a>00130 <span class="keyword">typedef</span> <span class="keyword">typename</span> C::iterator base_iterator;
<a name="l00131"></a>00131 <span class="keyword">typedef</span> <span class="keyword">typename</span> C::value_type <a class="code" href="structboost_1_1geometry_1_1point__type.html" title="Meta-function which defines point type of any geometry.">point_type</a>;
<a name="l00132"></a>00132 <span class="keywordflow">return</span> <a class="code" href="structboost_1_1geometry_1_1segment__iterator.html">segment_iterator&lt;base_iterator, point_type&gt;</a>(c.begin(), c.end());
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134
<a name="l00135"></a>00135 }} <span class="comment">// namespace boost::geometry</span>
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="preprocessor">#endif // BOOST_GEOMETRY_ITERATORS_SEGMENT_ITERATOR_HPP</span>
</pre></div></div>
<hr size="1">
<table width="100%">
<tbody>
<tr>
<td align="left"><small>
<p>December 1, 2009</p>
</small></td>
<td align="right">
<small>Copyright <20> 1995-2009 Barend Gehrels, Geodan, Amsterdam<br>
Copyright <20> 2008-2009 Bruno Lalande, Paris<br>
Copyright <20> 2009 Mateusz Loskot, Cadcorp, London<br>
</small>
</td>
</tr>
</tbody>
</table>
<address style="text-align: right;"><small>
Documentation is generated by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen</a>
</small></address>
</body>
</html>