structboost_1_1gil_1_1_random_access_n_d_locator_concept.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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: RandomAccessNDLocatorConcept&lt; Loc &gt; Struct 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="structboost_1_1gil_1_1_random_access_n_d_locator_concept.html">RandomAccessNDLocatorConcept</a></li> </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#pub-methods">Public Member Functions</a> &#124;
  48. <a href="#pub-attribs">Public Attributes</a> &#124;
  49. <a href="structboost_1_1gil_1_1_random_access_n_d_locator_concept-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">RandomAccessNDLocatorConcept&lt; Loc &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___pixel_locator.html">Pixel Locator</a> &raquo; <a class="el" href="group___pixel_locator_concept.html">Concepts</a> &raquo; <a class="el" href="group___locator_n_d_concept.html">RandomAccessNDLocatorConcept</a></div></div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>N-dimensional locator over immutable values.
  55. <a href="structboost_1_1gil_1_1_random_access_n_d_locator_concept.html#details">More...</a></p>
  56. <p><code>#include &lt;<a class="el" href="pixel__locator_8hpp_source.html">pixel_locator.hpp</a>&gt;</code></p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memItemLeft" align="right" valign="top"><a id="ab0a0dbf6ca9028bbbb2240cad5882537"></a>
  61. void&#160;</td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
  62. <tr class="separator:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. </table><table class="memberdecls">
  64. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  65. Public Attributes</h2></td></tr>
  66. <tr class="memitem:a78b239cb3da334ec5ca272453ae698f1"><td class="memItemLeft" align="right" valign="top"><a id="a78b239cb3da334ec5ca272453ae698f1"></a>
  67. Loc&#160;</td><td class="memItemRight" valign="bottom"><b>loc</b></td></tr>
  68. <tr class="separator:a78b239cb3da334ec5ca272453ae698f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. </table>
  70. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  71. <div class="textblock"><h3>template&lt;typename Loc&gt;<br />
  72. struct boost::gil::RandomAccessNDLocatorConcept&lt; Loc &gt;</h3>
  73. <p>N-dimensional locator over immutable values. </p>
  74. <div class="fragment"><div class="line">concept RandomAccessNDLocatorConcept&lt;Regular Loc&gt;</div><div class="line">{</div><div class="line"> <span class="keyword">typename</span> value_type; <span class="comment">// value over which the locator navigates</span></div><div class="line"> <span class="keyword">typename</span> reference; <span class="comment">// result of dereferencing</span></div><div class="line"> <span class="keyword">typename</span> difference_type; where PointNDConcept&lt;difference_type&gt;; <span class="comment">// return value of operator-.</span></div><div class="line"> <span class="keyword">typename</span> const_t; <span class="comment">// same as Loc, but operating over immutable values</span></div><div class="line"> <span class="keyword">typename</span> cached_location_t; <span class="comment">// type to store relative location (for efficient repeated access)</span></div><div class="line"> <span class="keyword">typename</span> point_t = difference_type;</div><div class="line"></div><div class="line"> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> num_dimensions; <span class="comment">// dimensionality of the locator</span></div><div class="line"> where num_dimensions = point_t::num_dimensions;</div><div class="line"></div><div class="line"> <span class="comment">// The difference_type and iterator type along each dimension. The iterators may only differ in</span></div><div class="line"> <span class="comment">// difference_type. Their value_type must be the same as Loc::value_type</span></div><div class="line"> <span class="keyword">template</span> &lt;<span class="keywordtype">size_t</span> D&gt;</div><div class="line"> <span class="keyword">struct </span>axis</div><div class="line"> {</div><div class="line"> <span class="keyword">typename</span> coord_t = point_t::axis&lt;D&gt;::coord_t;</div><div class="line"> <span class="keyword">typename</span> iterator; where RandomAccessTraversalConcept&lt;iterator&gt;; <span class="comment">// iterator along D-th axis.</span></div><div class="line"> where iterator::value_type == value_type;</div><div class="line"> };</div><div class="line"></div><div class="line"> <span class="comment">// Defines the type of a locator similar to this type, except it invokes Deref upon dereferencing</span></div><div class="line"> <span class="keyword">template</span> &lt;PixelDereferenceAdaptorConcept Deref&gt;</div><div class="line"> <span class="keyword">struct </span>add_deref</div><div class="line"> {</div><div class="line"> <span class="keyword">typename</span> type;</div><div class="line"> where RandomAccessNDLocatorConcept&lt;type&gt;;</div><div class="line"> <span class="keyword">static</span> type make(<span class="keyword">const</span> Loc&amp; loc, <span class="keyword">const</span> Deref&amp; deref);</div><div class="line"> };</div><div class="line"></div><div class="line"> Loc&amp; operator+=(Loc&amp;, <span class="keyword">const</span> difference_type&amp;);</div><div class="line"> Loc&amp; operator-=(Loc&amp;, <span class="keyword">const</span> difference_type&amp;);</div><div class="line"> Loc operator+(<span class="keyword">const</span> Loc&amp;, <span class="keyword">const</span> difference_type&amp;);</div><div class="line"> Loc operator-(<span class="keyword">const</span> Loc&amp;, <span class="keyword">const</span> difference_type&amp;);</div><div class="line"></div><div class="line"> reference operator*(<span class="keyword">const</span> Loc&amp;);</div><div class="line"> reference operator[](<span class="keyword">const</span> Loc&amp;, <span class="keyword">const</span> difference_type&amp;);</div><div class="line"></div><div class="line"> <span class="comment">// Storing relative location for faster repeated access and accessing it</span></div><div class="line"> cached_location_t Loc::cache_location(<span class="keyword">const</span> difference_type&amp;) <span class="keyword">const</span>;</div><div class="line"> reference operator[](<span class="keyword">const</span> Loc&amp;,<span class="keyword">const</span> cached_location_t&amp;);</div><div class="line"></div><div class="line"> <span class="comment">// Accessing iterators along a given dimension at the current location or at a given offset</span></div><div class="line"> <span class="keyword">template</span> &lt;<span class="keywordtype">size_t</span> D&gt; axis&lt;D&gt;::iterator&amp; Loc::axis_iterator();</div><div class="line"> <span class="keyword">template</span> &lt;<span class="keywordtype">size_t</span> D&gt; axis&lt;D&gt;::iterator <span class="keyword">const</span>&amp; Loc::axis_iterator() <span class="keyword">const</span>;</div><div class="line"> <span class="keyword">template</span> &lt;<span class="keywordtype">size_t</span> D&gt; axis&lt;D&gt;::iterator Loc::axis_iterator(<span class="keyword">const</span> difference_type&amp;) <span class="keyword">const</span>;</div><div class="line">};</div></div><!-- fragment --> </div><hr/>The documentation for this struct was generated from the following file:<ul>
  75. <li><a class="el" href="pixel__locator_8hpp_source.html">pixel_locator.hpp</a></li>
  76. </ul>
  77. </div><!-- contents -->
  78. <!-- HTML footer for doxygen 1.8.13-->
  79. <!-- start footer part -->
  80. <hr class="footer"/>
  81. <address class="footer">
  82. <small>
  83. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  84. </small>
  85. </address>
  86. </body>
  87. </html>