libs/gil/doc/html/reference/structboost_1_1gil_1_1_random_access_n_d_image_view_concept.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: RandomAccessNDImageViewConcept&lt; View &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_image_view_concept.html">RandomAccessNDImageViewConcept</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_image_view_concept-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">RandomAccessNDImageViewConcept&lt; View &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group___image_view.html">Image View</a> &raquo; <a class="el" href="group___image_view_concept.html">Concepts</a> &raquo; <a class="el" href="group___image_view_n_d_concept.html">ImageViewNDLocatorConcept</a></div></div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p>N-dimensional view over immutable values.
  56  <a href="structboost_1_1gil_1_1_random_access_n_d_image_view_concept.html#details">More...</a></p>
  57
  58 <p><code>#include &lt;<a class="el" href="concepts_2image__view_8hpp_source.html">image_view.hpp</a>&gt;</code></p>
  59 <table class="memberdecls">
  60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  61 Public Member Functions</h2></td></tr>
  62 <tr class="memitem:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memItemLeft" align="right" valign="top"><a id="ab0a0dbf6ca9028bbbb2240cad5882537"></a>
  63 void&#160;</td><td class="memItemRight" valign="bottom"><b>constraints</b> ()</td></tr>
  64 <tr class="separator:ab0a0dbf6ca9028bbbb2240cad5882537"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 </table><table class="memberdecls">
  66 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  67 Public Attributes</h2></td></tr>
  68 <tr class="memitem:aac435eb4d053aa36fa4760f634ca37ca"><td class="memItemLeft" align="right" valign="top"><a id="aac435eb4d053aa36fa4760f634ca37ca"></a>
  69 View&#160;</td><td class="memItemRight" valign="bottom"><b>view</b></td></tr>
  70 <tr class="separator:aac435eb4d053aa36fa4760f634ca37ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 </table>
  72 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  73 <div class="textblock"><h3>template&lt;typename View&gt;<br />
  74 struct boost::gil::RandomAccessNDImageViewConcept&lt; View &gt;</h3>
  75
  76 <p>N-dimensional view over immutable values. </p>
  77 <div class="fragment"><div class="line">concept RandomAccessNDImageViewConcept&lt;Regular View&gt;</div><div class="line">{</div><div class="line">    <span class="keyword">typename</span> value_type;</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; <span class="comment">// result of operator-(iterator,iterator) (1-dimensional!)</span></div><div class="line">    <span class="keyword">typename</span> const_t;  where RandomAccessNDImageViewConcept&lt;View&gt;; <span class="comment">// same as View, but over immutable values</span></div><div class="line">    <span class="keyword">typename</span> point_t;  where PointNDConcept&lt;point_t&gt;; <span class="comment">// N-dimensional point</span></div><div class="line">    <span class="keyword">typename</span> locator;  where RandomAccessNDLocatorConcept&lt;locator&gt;; <span class="comment">// N-dimensional locator.</span></div><div class="line">    <span class="keyword">typename</span> iterator; where RandomAccessTraversalConcept&lt;iterator&gt;; <span class="comment">// 1-dimensional iterator over all values</span></div><div class="line">    <span class="keyword">typename</span> reverse_iterator; where RandomAccessTraversalConcept&lt;reverse_iterator&gt;;</div><div class="line">    <span class="keyword">typename</span> size_type;       <span class="comment">// the return value of size()</span></div><div class="line"></div><div class="line">    <span class="comment">// Equivalent to RandomAccessNDLocatorConcept::axis</span></div><div class="line">    <span class="keyword">template</span> &lt;<span class="keywordtype">size_t</span> D&gt; <span class="keyword">struct </span>axis {</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 SameType&lt;coord_t, iterator::difference_type&gt;;</div><div class="line">        where SameType&lt;iterator::value_type,value_type&gt;;</div><div class="line">    };</div><div class="line"></div><div class="line">    <span class="comment">// Defines the type of a view similar to this type, except it invokes Deref upon dereferencing</span></div><div class="line">    <span class="keyword">template</span> &lt;PixelDereferenceAdaptorConcept Deref&gt; <span class="keyword">struct </span>add_deref {</div><div class="line">        <span class="keyword">typename</span> type;        where RandomAccessNDImageViewConcept&lt;type&gt;;</div><div class="line">        <span class="keyword">static</span> type make(<span class="keyword">const</span> View&amp; v, <span class="keyword">const</span> Deref&amp; deref);</div><div class="line">    };</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 = point_t::num_dimensions;</div><div class="line"></div><div class="line">    <span class="comment">// Create from a locator at the top-left corner and dimensions</span></div><div class="line">    View::View(<span class="keyword">const</span> locator&amp;, <span class="keyword">const</span> point_type&amp;);</div><div class="line"></div><div class="line">    size_type        View::size()       <span class="keyword">const</span>; <span class="comment">// total number of elements</span></div><div class="line">    reference        operator[](View, <span class="keyword">const</span> difference_type&amp;) <span class="keyword">const</span>; <span class="comment">// 1-dimensional reference</span></div><div class="line">    iterator         View::begin()      <span class="keyword">const</span>;</div><div class="line">    iterator         View::end()        <span class="keyword">const</span>;</div><div class="line">    reverse_iterator View::rbegin()     <span class="keyword">const</span>;</div><div class="line">    reverse_iterator View::rend()       <span class="keyword">const</span>;</div><div class="line">    iterator         View::at(<span class="keyword">const</span> point_t&amp;);</div><div class="line">    point_t          View::dimensions() <span class="keyword">const</span>; <span class="comment">// number of elements along each dimension</span></div><div class="line">    <span class="keywordtype">bool</span>             View::is_1d_traversable() <span class="keyword">const</span>;   <span class="comment">// can an iterator over the first dimension visit each value? I.e. are there gaps between values?</span></div><div class="line"></div><div class="line">    <span class="comment">// iterator along a given dimension starting at a given point</span></div><div class="line">    <span class="keyword">template</span> &lt;<span class="keywordtype">size_t</span> D&gt; View::axis&lt;D&gt;::iterator View::axis_iterator(<span class="keyword">const</span> point_t&amp;) <span class="keyword">const</span>;</div><div class="line"></div><div class="line">    reference operator()(View,<span class="keyword">const</span> point_t&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>
  78 <li><a class="el" href="concepts_2image__view_8hpp_source.html">concepts/image_view.hpp</a></li>
  79 </ul>
  80 </div><!-- contents -->
  81      <!-- HTML footer for doxygen 1.8.13-->
  82      <!-- start footer part -->
  83      <hr class="footer"/>
  84      <address class="footer">
  85       <small>
  86         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  87       </small>
  88     </address>
  89   </body>
  90 </html>