libs/compute/doc/html/boost/compute/extents.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template extents</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Compute">
   8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp" title="Header &lt;boost/compute/utility/extents.hpp&gt;">
   9 <link rel="prev" href="dim.html" title="Function template dim">
  10 <link rel="next" href="invoke.html" title="Function template invoke">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="dim.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="invoke.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.extents"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template extents</span></h2>
  29 <p>boost::compute::extents</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp" title="Header &lt;boost/compute/utility/extents.hpp&gt;">boost/compute/utility/extents.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">size_t</span> N<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">size_t</span>                     <a name="boost.compute.extents.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span><span class="special">&lt;</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">N</span> <span class="special">&gt;</span>  <a name="boost.compute.extents.array_type"></a><span class="identifier">array_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">array_type</span><span class="special">::</span><span class="identifier">iterator</span>       <a name="boost.compute.extents.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">array_type</span><span class="special">::</span><span class="identifier">const_iterator</span> <a name="boost.compute.extents.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="extents.html#boost.compute.extentsconstruct-copy-destruct">construct/copy/destruct</a></span>
  44   <a class="link" href="extents.html#idp49898672-bb"><span class="identifier">extents</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">explicit</span> <a class="link" href="extents.html#idp49900448-bb"><span class="identifier">extents</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="extents.html#idp49903616-bb"><span class="identifier">extents</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">size_t</span> <span class="special">&gt;</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="extents.html#idp49872512-bb">public member functions</a></span>
  49   <span class="identifier">size_type</span> <a class="link" href="extents.html#idp49873072-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50   <span class="identifier">size_type</span> <a class="link" href="extents.html#idp49874528-bb"><span class="identifier">linear</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  51   <span class="identifier">size_t</span> <span class="special">*</span> <a class="link" href="extents.html#idp49876160-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">*</span> <a class="link" href="extents.html#idp49878256-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="identifier">iterator</span> <a class="link" href="extents.html#idp49879920-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  54   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idp49880768-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idp49881888-bb"><span class="identifier">cbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="identifier">iterator</span> <a class="link" href="extents.html#idp49883008-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  57   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idp49883856-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <span class="identifier">const_iterator</span> <a class="link" href="extents.html#idp49884976-bb"><span class="identifier">cend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="identifier">size_t</span> <span class="special">&amp;</span> <a class="link" href="extents.html#idp49886096-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">&amp;</span> <a class="link" href="extents.html#idp49888384-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61   <span class="keyword">bool</span> <a class="link" href="extents.html#idp49890736-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  62   <span class="keyword">bool</span> <a class="link" href="extents.html#idp49894624-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63
  64   <span class="comment">// public data members</span>
  65   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <span class="identifier">static_size</span><span class="special">;</span>
  66 <span class="special">}</span><span class="special">;</span></pre></div>
  67 <div class="refsect1">
  68 <a name="idp112120272"></a><h2>Description</h2>
  69 <p>The extents class contains an array of n-dimensional extents.</p>
  70 <p><span class="bold"><strong>See Also:</strong></span></p>
  71 <p>dim() </p>
  72 <p>
  73 </p>
  74 <div class="refsect2">
  75 <a name="idp112122256"></a><h3>
  76 <a name="boost.compute.extentsconstruct-copy-destruct"></a><code class="computeroutput">extents</code>
  77         public
  78        construct/copy/destruct</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1">
  80 <li class="listitem">
  81 <pre class="literallayout"><a name="idp49898672-bb"></a><span class="identifier">extents</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  82 <p>Creates an extents object with each component set to zero.</p>
  83 <p>For example: </p>
  84 <pre class="programlisting"><span class="identifier">extents</span><span class="special">&lt;</span><span class="number">3</span><span class="special">&gt;</span> <span class="identifier">exts</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">// (0, 0, 0)</span>
  85 </pre>
  86 <p> </p>
  87 </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp49900448-bb"></a><span class="identifier">extents</span><span class="special">(</span><span class="identifier">size_t</span> value<span class="special">)</span><span class="special">;</span></pre>
  90 <p>Creates an extents object with each component set to <code class="computeroutput">value</code>.</p>
  91 <p>For example: </p>
  92 <pre class="programlisting"><span class="identifier">extents</span><span class="special">&lt;</span><span class="number">3</span><span class="special">&gt;</span> <span class="identifier">exts</span><span class="special">(</span><span class="number">1</span><span class="special">)</span><span class="special">;</span> <span class="comment">// (1, 1, 1)</span>
  93 </pre>
  94 <p> </p>
  95 </li>
  96 <li class="listitem">
  97 <pre class="literallayout"><a name="idp49903616-bb"></a><span class="identifier">extents</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">size_t</span> <span class="special">&gt;</span> values<span class="special">)</span><span class="special">;</span></pre>Creates an extents object with <code class="computeroutput">values</code>. </li>
  98 </ol></div>
  99 </div>
 100 <div class="refsect2">
 101 <a name="idp112155536"></a><h3>
 102 <a name="idp49872512-bb"></a><code class="computeroutput">extents</code> public member functions</h3>
 103 <div class="orderedlist"><ol class="orderedlist" type="1">
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp49873072-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size (i.e. dimensionality) of the extents array. </li>
 106 <li class="listitem">
 107 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp49874528-bb"></a><span class="identifier">linear</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 108 <p>Returns the linear size of the extents. This is equivalent to the product of each extent in each dimension. </p>
 109 </li>
 110 <li class="listitem">
 111 <pre class="literallayout"><span class="identifier">size_t</span> <span class="special">*</span> <a name="idp49876160-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 112 <p>Returns a pointer to the extents data array.</p>
 113 <p>This is useful for passing the extents data to OpenCL APIs which expect an array of <code class="computeroutput">size_t</code>. </p>
 114 </li>
 115 <li class="listitem">
 116 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">*</span> <a name="idp49878256-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 117 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 118 </li>
 119 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp49879920-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 120 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp49880768-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 121 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp49881888-bb"></a><span class="identifier">cbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 122 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp49883008-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 123 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp49883856-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 124 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp49884976-bb"></a><span class="identifier">cend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 125 <li class="listitem">
 126 <pre class="literallayout"><span class="identifier">size_t</span> <span class="special">&amp;</span> <a name="idp49886096-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_t</span> index<span class="special">)</span><span class="special">;</span></pre>Returns a reference to the extent at <code class="computeroutput">index</code>. </li>
 127 <li class="listitem">
 128 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">size_t</span> <span class="special">&amp;</span> <a name="idp49888384-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_t</span> index<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 129 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 130 </li>
 131 <li class="listitem">
 132 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp49890736-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the extents in <code class="computeroutput">*this</code> are the same as <code class="computeroutput">other</code>. </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp49894624-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="extents.html" title="Class template extents">extents</a> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the extents in <code class="computeroutput">*this</code> are not the same as <code class="computeroutput">other</code>. </li>
 135 </ol></div>
 136 </div>
 137 </div>
 138 </div>
 139 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 140 <td align="left"></td>
 141 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 142         Distributed under the Boost Software License, Version 1.0. (See accompanying
 143         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 144       </p>
 145 </div></td>
 146 </tr></table>
 147 <hr>
 148 <div class="spirit-nav">
 149 <a accesskey="p" href="dim.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.utility.extents_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="invoke.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 150 </div>
 151 </body>
 152 </html>