libs/gil/doc/html/reference/classboost_1_1gil_1_1iterator__from__2d.html

   1 <!-- HTML header for doxygen 1.8.13-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7     <meta name="generator" content="Doxygen 1.8.15"/>
   8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9     <title>Generic Image Library: iterator_from_2d&lt; Loc2 &gt; Class Template Reference</title>
  10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11     <script type="text/javascript" src="jquery.js"></script>
  12     <script type="text/javascript" src="dynsections.js"></script>
  13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15   </head>
  16   <body>
  17     <div class="boost-header">
  18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19         <tr>
  20           <td valign="top" width="300">
  21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22           </td>
  23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24           <td></td>
  25         </tr>
  26       </table>
  27     </div>
  28     <hr/>
  29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30 <!-- Generated by Doxygen 1.8.15 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 <div id="nav-path" class="navpath">
  41   <ul>
  42 <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">iterator_from_2d</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-types">Public Types</a> &#124;
  48 <a href="#pub-methods">Public Member Functions</a> &#124;
  49 <a href="#friends">Friends</a> &#124;
  50 <a href="classboost_1_1gil_1_1iterator__from__2d-members.html">List of all members</a>  </div>
  51   <div class="headertitle">
  52 <div class="title">iterator_from_2d&lt; Loc2 &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___pixel_iterator.html">Pixel Iterator</a> &raquo; <a class="el" href="group___pixel_iterator_model.html">Models</a> &raquo; <a class="el" href="group___pixel_iterator_model_from_locator.html">iterator_from_2d</a><a class="el" href="group___pixel_based.html">PixelBased</a> &raquo;  &#124; <a class="el" href="group___pixel_based_model.html">Models</a></div></div>  </div>
  53 </div><!--header-->
  54 <div class="contents">
  55
  56 <p>Provides 1D random-access navigation to the pixels of the image. Models: <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>.
  57  <a href="classboost_1_1gil_1_1iterator__from__2d.html#details">More...</a></p>
  58
  59 <p><code>#include &lt;<a class="el" href="iterator__from__2d_8hpp_source.html">iterator_from_2d.hpp</a>&gt;</code></p>
  60
  61 <p>Inherits iterator_facade&lt; iterator_from_2d&lt; Loc2 &gt;, Loc2::value_type, std::random_access_iterator_tag, Loc2::reference, Loc2::coord_t &gt;.</p>
  62 <table class="memberdecls">
  63 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  64 Public Types</h2></td></tr>
  65 <tr class="memitem:a8e05f46506fc19e0870317ba11a9b3f4"><td class="memItemLeft" align="right" valign="top"><a id="a8e05f46506fc19e0870317ba11a9b3f4"></a>
  66 using&#160;</td><td class="memItemRight" valign="bottom"><b>parent_t</b> = iterator_facade&lt; <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">iterator_from_2d</a>&lt; Loc2 &gt;, typename Loc2::value_type, std::random_access_iterator_tag, typename Loc2::reference, typename Loc2::coord_t &gt;</td></tr>
  67 <tr class="separator:a8e05f46506fc19e0870317ba11a9b3f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memItemLeft" align="right" valign="top"><a id="afd3670b743c9f80b9c2f6b3ccb5fe37c"></a>
  69 using&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b> = typename parent_t::reference</td></tr>
  70 <tr class="separator:afd3670b743c9f80b9c2f6b3ccb5fe37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memItemLeft" align="right" valign="top"><a id="a2ae9f9bc144b7bd7d8523c345ac34a58"></a>
  72 using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename parent_t::difference_type</td></tr>
  73 <tr class="separator:a2ae9f9bc144b7bd7d8523c345ac34a58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:ab58fe691a00439e2e83c0833b4366aba"><td class="memItemLeft" align="right" valign="top"><a id="ab58fe691a00439e2e83c0833b4366aba"></a>
  75 using&#160;</td><td class="memItemRight" valign="bottom"><b>x_iterator</b> = typename Loc2::x_iterator</td></tr>
  76 <tr class="separator:ab58fe691a00439e2e83c0833b4366aba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:ad6ee61b550d94b8db75e297589d8e6a9"><td class="memItemLeft" align="right" valign="top"><a id="ad6ee61b550d94b8db75e297589d8e6a9"></a>
  78 using&#160;</td><td class="memItemRight" valign="bottom"><b>point_t</b> = typename Loc2::point_t</td></tr>
  79 <tr class="separator:ad6ee61b550d94b8db75e297589d8e6a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 </table><table class="memberdecls">
  81 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  82 Public Member Functions</h2></td></tr>
  83 <tr class="memitem:a97a39c58c1610814c8129de452b6f1d8"><td class="memItemLeft" align="right" valign="top"><a id="a97a39c58c1610814c8129de452b6f1d8"></a>
  84 std::ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><b>width</b> () const</td></tr>
  85 <tr class="separator:a97a39c58c1610814c8129de452b6f1d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <tr class="memitem:a666fada3672dd1bc3a2cdad1a3ff807b"><td class="memItemLeft" align="right" valign="top"><a id="a666fada3672dd1bc3a2cdad1a3ff807b"></a>
  87 std::ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><b>x_pos</b> () const</td></tr>
  88 <tr class="separator:a666fada3672dd1bc3a2cdad1a3ff807b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:a94da8c1ece4b8c3c90ca742309080811"><td class="memItemLeft" align="right" valign="top"><a id="a94da8c1ece4b8c3c90ca742309080811"></a>
  90 std::ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><b>y_pos</b> () const</td></tr>
  91 <tr class="separator:a94da8c1ece4b8c3c90ca742309080811"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a16d8e6857dd561244ca73764f2b94801"><td class="memItemLeft" align="right" valign="top">reference&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html#a16d8e6857dd561244ca73764f2b94801">operator[]</a> (difference_type d) const</td></tr>
  93 <tr class="separator:a16d8e6857dd561244ca73764f2b94801"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:a8dbef8d72f426f316b3a789ad884f47a"><td class="memItemLeft" align="right" valign="top"><a id="a8dbef8d72f426f316b3a789ad884f47a"></a>
  95 bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_1d_traversable</b> () const</td></tr>
  96 <tr class="separator:a8dbef8d72f426f316b3a789ad884f47a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <tr class="memitem:a72169bdc650ac7eda288398e4ce1d7f8"><td class="memItemLeft" align="right" valign="top"><a id="a72169bdc650ac7eda288398e4ce1d7f8"></a>
  98 x_iterator &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>x</b> ()</td></tr>
  99 <tr class="separator:a72169bdc650ac7eda288398e4ce1d7f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 <tr class="memitem:a45df0fa110e66d8fb30cb24c1dd56266"><td class="memItemLeft" align="right" valign="top"><a id="a45df0fa110e66d8fb30cb24c1dd56266"></a>
 101 &#160;</td><td class="memItemRight" valign="bottom"><b>iterator_from_2d</b> (const Loc2 &amp;p, std::ptrdiff_t width, std::ptrdiff_t x=0, std::ptrdiff_t y=0)</td></tr>
 102 <tr class="separator:a45df0fa110e66d8fb30cb24c1dd56266"><td class="memSeparator" colspan="2">&#160;</td></tr>
 103 <tr class="memitem:acb7687c40d4a935c63ac210d97c22aa4"><td class="memItemLeft" align="right" valign="top"><a id="acb7687c40d4a935c63ac210d97c22aa4"></a>
 104 &#160;</td><td class="memItemRight" valign="bottom"><b>iterator_from_2d</b> (const <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">iterator_from_2d</a> &amp;pit)</td></tr>
 105 <tr class="separator:acb7687c40d4a935c63ac210d97c22aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 <tr class="memitem:a09776b4045a3c08cf268fc2ece1d87ab"><td class="memTemplParams" colspan="2"><a id="a09776b4045a3c08cf268fc2ece1d87ab"></a>
 107 template&lt;typename Loc &gt; </td></tr>
 108 <tr class="memitem:a09776b4045a3c08cf268fc2ece1d87ab"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iterator_from_2d</b> (const <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">iterator_from_2d</a>&lt; Loc &gt; &amp;pit)</td></tr>
 109 <tr class="separator:a09776b4045a3c08cf268fc2ece1d87ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 110 <tr class="memitem:a038d74f757b05e86180e22ba558cf055"><td class="memItemLeft" align="right" valign="top"><a id="a038d74f757b05e86180e22ba558cf055"></a>
 111 <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">iterator_from_2d</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">iterator_from_2d</a> const &amp;other)=default</td></tr>
 112 <tr class="separator:a038d74f757b05e86180e22ba558cf055"><td class="memSeparator" colspan="2">&#160;</td></tr>
 113 </table><table class="memberdecls">
 114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
 115 Friends</h2></td></tr>
 116 <tr class="memitem:a8c1e271678b0091512eb046114c042f6"><td class="memTemplParams" colspan="2"><a id="a8c1e271678b0091512eb046114c042f6"></a>
 117 template&lt;typename Loc &gt; </td></tr>
 118 <tr class="memitem:a8c1e271678b0091512eb046114c042f6"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iterator_from_2d</b></td></tr>
 119 <tr class="separator:a8c1e271678b0091512eb046114c042f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 <tr class="memitem:ac09f73e325921cc50ebcd96bed0f8096"><td class="memItemLeft" align="right" valign="top"><a id="ac09f73e325921cc50ebcd96bed0f8096"></a>
 121 class&#160;</td><td class="memItemRight" valign="bottom"><b>boost::iterator_core_access</b></td></tr>
 122 <tr class="separator:ac09f73e325921cc50ebcd96bed0f8096"><td class="memSeparator" colspan="2">&#160;</td></tr>
 123 </table>
 124 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 125 <div class="textblock"><h3>template&lt;typename Loc2&gt;<br />
 126 class boost::gil::iterator_from_2d&lt; Loc2 &gt;</h3>
 127
 128 <p>Provides 1D random-access navigation to the pixels of the image. Models: <a class="el" href="structboost_1_1gil_1_1_pixel_iterator_concept.html" title="An STL random access traversal iterator over a model of PixelConcept.">PixelIteratorConcept</a>, <a class="el" href="structboost_1_1gil_1_1_pixel_based_concept.html" title="Concept for all pixel-based GIL constructs.">PixelBasedConcept</a>, <a class="el" href="structboost_1_1gil_1_1_has_dynamic_x_step_type_concept.html" title="Concept for iterators, locators and views that can define a type just like the given iterator,...">HasDynamicXStepTypeConcept</a>. </p>
 129 <p>Pixels are traversed from the top to the bottom row and from the left to the right within each row </p>
 130 </div><h2 class="groupheader">Member Function Documentation</h2>
 131 <a id="a16d8e6857dd561244ca73764f2b94801"></a>
 132 <h2 class="memtitle"><span class="permalink"><a href="#a16d8e6857dd561244ca73764f2b94801">&#9670;&nbsp;</a></span>operator[]()</h2>
 133
 134 <div class="memitem">
 135 <div class="memproto">
 136 <table class="mlabels">
 137   <tr>
 138   <td class="mlabels-left">
 139       <table class="memname">
 140         <tr>
 141           <td class="memname">reference operator[] </td>
 142           <td>(</td>
 143           <td class="paramtype">difference_type&#160;</td>
 144           <td class="paramname"><em>d</em></td><td>)</td>
 145           <td> const</td>
 146         </tr>
 147       </table>
 148   </td>
 149   <td class="mlabels-right">
 150 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 151   </tr>
 152 </table>
 153 </div><div class="memdoc">
 154 <p>For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits </p>
 155
 156 </div>
 157 </div>
 158 <hr/>The documentation for this class was generated from the following file:<ul>
 159 <li><a class="el" href="iterator__from__2d_8hpp_source.html">iterator_from_2d.hpp</a></li>
 160 </ul>
 161 </div><!-- contents -->
 162      <!-- HTML footer for doxygen 1.8.13-->
 163      <!-- start footer part -->
 164      <hr class="footer"/>
 165      <address class="footer">
 166       <small>
 167         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 168       </small>
 169     </address>
 170   </body>
 171 </html>